@rasadov/lumoar-sdk 1.9.1 → 2.0.1

package/README.md

@@ -1,4 +1,6 @@
-# Lumoar SDK
+# @rasadov/lumoar-sdk
+
+Lumoar API SDK for dashboard use (session-based authentication)
 
 ## Installation
 
@@ -9,16 +11,26 @@ npm install @rasadov/lumoar-sdk
 ## Usage
 
 ```typescript
-import { ApiSDK } from '@rasadov/lumoar-sdk';
+import { Configuration } from '@rasadov/lumoar-sdk';
+import { YourApi } from '@rasadov/lumoar-sdk';
+
+const config = new Configuration({
+  basePath: 'https://api.example.com',
+  // Session and authorization handled automatically via cookies
+});
 
-const api = new ApiSDK();
-api.getCompaniesV1CompanyListGet();
+const api = new YourApi(config);
 ```
 
-## Generate SDK
+## OpenAPI Specification
+
+This SDK is generated from the OpenAPI specification included in this package. You can find the OpenAPI spec at `openapi.json` in the package root.
+
+If you want to generate an SDK in a different language, you can use the included OpenAPI specification with [OpenAPI Generator](https://openapi-generator.tech/).
 
 ```bash
-openapi-generator-cli generate   -i http://localhost:8000/openapi.json   -g typescript-axios   -o .
+# Example: Generate Python SDK
+openapi-generator-cli generate -i node_modules/@rasadov/lumoar-sdk/openapi.json -g python -o ./python-sdk
 ```
 
 ## License