add readme

Author: azmy60

README.md

@@ -0,0 +1,48 @@
+# @beekeeperstudio/plugin
+
+A TypeScript wrapper library for building Beekeeper Studio plugins that enables communication between your plugin and the main application.
+
+## Installation
+
+```bash
+npm install @beekeeperstudio/plugin
+```
+
+## Quick Start
+
+```typescript
+import { request, notify } from '@beekeeperstudio/plugin';
+
+// Get all tables in the current database
+const tables = await request('getTables');
+
+// Run a SQL query
+const result = await request('runQuery', { query: 'SELECT * FROM users LIMIT 10' });
+```
+
+## TypeScript Support
+
+The library includes comprehensive TypeScript definitions:
+
+```typescript
+import type {
+  QueryResult,
+  ThemeType,
+  GetTablesResponse
+} from '@beekeeperstudio/plugin';
+```
+
+## Development
+
+```bash
+# Build the library
+npm run build
+
+# Prepare for publishing
+npm run prepublishOnly
+```
+
+## License
+
+MIT - see [LICENSE](LICENSE) file for details.
+