@sheet2db/sdk 1.0.1 → 1.0.2

package/README.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-`Sheet2DB` is a TypeScript class that provides an easy interface to interact with Google Sheets via the `sheet2db` API. This class abstracts the complexity of API calls and provides a simple way to read, write, update, and delete data in Google Sheets. It supports both browser and Node.js environments.
+`Sheet2DB` is a TypeScript class that provides an easy interface to interact with Google Sheets via the [`sheet2db`](https://sheet2db.com) API. This class abstracts the complexity of API calls and provides a simple way to read, write, update, and delete data in Google Sheets. It supports both browser and Node.js environments.
 
 ## Installation
 
@@ -10,6 +10,19 @@
 npm install sheet2db
 ```
 
+## Configuration Options
+
+### Sheet2DBOptions
+
+- **mode**: `'apikey' | 'connectionId'` - Authentication mode.
+- **apiKey**: `string` (required for `'apikey'` mode) - API key for accessing the spreadsheet.
+- **spreadsheetId**: `string` (required for `'apikey'` mode) - The ID of the Google spreadsheet.
+- **version**: `"v1"` - API version, always "v1".
+- **connectionId**: `string` (required for `'connectionId'` mode) - Connection ID for accessing the spreadsheet.
+- **basicAuth**: `{ username: string; password: string; }` (optional for `'connectionId'` mode) - Basic authentication credentials.
+- **jwtAuth**: `{ bearerToken: string; }` (optional for `'connectionId'` mode) - JWT authentication token.
+- **fetchFn**: `typeof fetch` (optional) - Custom fetch function.
+
 ## Usage
 
 ### Import and Initialize
@@ -24,6 +37,12 @@ const options: Sheet2DBOptions = {
     version: 'v1'
 };
 
+const options: Sheet2DBOptions = {
+    mode: 'connectionId',
+    connectionId: 'your-connection-id',
+    version: 'v1'
+};
+
 const sheet2db = new Sheet2DB(options);
 ```
 
@@ -280,18 +299,7 @@ sheet2db.DeleteSheet({ sheet: 'Sheet1' })
     .catch(error => console.error(error));
 ```
 
-## Configuration Options
 
-### Sheet2DBOptions
-
-- **mode**: `'apikey' | 'connectionId'` - Authentication mode.
-- **apiKey**: `string` (required for `'apikey'` mode) - API key for accessing the spreadsheet.
-- **spreadsheetId**: `string` (required for `'apikey'` mode) - The ID of the Google spreadsheet.
-- **version**: `"v1"` - API version, always "v1".
-- **connectionId**: `string` (required for `'connectionId'` mode) - Connection ID for accessing the spreadsheet.
-- **basicAuth**: `{ username: string; password: string; }` (optional for `'connectionId'` mode) - Basic authentication credentials.
-- **jwtAuth**: `{ bearerToken: string; }` (optional for `'connectionId'` mode) - JWT authentication token.
-- **fetchFn**: `typeof fetch` (optional) - Custom fetch function.
 
 ## Environment Detection
 
@@ -318,8 +326,4 @@ Each method returns a promise that resolves to the API response or rejects with
 sheet2db.ReadContent()
     .then(data => console.log(data))
     .catch(error => console.error(error));
-```
-
-## License
-
-This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sheet2db/sdk",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -14,7 +14,7 @@
     }
   },
   "author": "",
-  "license": "ISC",
+  "license": "MIT",
   "devDependencies": {
     "@jest/globals": "^29.7.0",
     "jest": "^29.7.0",