@cappasoft/openrouter-models 1.0.0 → 1.2.0

package/README.md

@@ -1,6 +1,8 @@
-# @cappasoft/openrouter-models
+# 🔌 @cappasoft/openrouter-models
 
-Headless client for fetching and grouping OpenRouter models.
+[![npm version](https://img.shields.io/npm/v/@cappasoft/openrouter-models.svg?style=flat-square)](https://www.npmjs.com/package/@cappasoft/openrouter-models)
+
+Headless TypeScript client for fetching and grouping [OpenRouter](https://openrouter.ai) models.
 
 ## Installation
 
@@ -17,8 +19,52 @@ const client = createOpenRouterModelsClient({
   apiKey: 'sk-or-v1-...',
 })
 
+// Fetch all models grouped by category
 const { models, categories } = await client.listModels()
-console.log(models.length, categories.map((c) => c.name))
+
+console.log(`Found ${models.length} models`)
+console.log(`Categories: ${categories.map(c => c.name).join(', ')}`)
+```
+
+## API
+
+### `createOpenRouterModelsClient(options)`
+
+Creates a client instance.
+
+```ts
+const client = createOpenRouterModelsClient({
+  apiKey: string,      // Your OpenRouter API key
+  baseUrl?: string,    // API base URL (optional)
+})
+```
+
+### `client.listModels()`
+
+Fetches all models and groups them by provider.
+
+```ts
+const { models, categories } = await client.listModels()
+```
+
+### Types
+
+```ts
+interface OpenRouterModel {
+  id: string
+  name: string
+  description?: string
+  context_length: number
+  pricing: { prompt: string; completion: string }
+  // ... more fields
+}
+
+interface ModelCategory {
+  name: string
+  models: OpenRouterModel[]
+}
 ```
 
+## License
 
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cappasoft/openrouter-models",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "Headless client for fetching and managing OpenRouter models",
   "type": "module",
   "main": "./dist/index.js",
@@ -36,4 +36,4 @@
     "tsup": "^8.3.5",
     "typescript": "^5.8.3"
   }
-}
+}