@s-berdia/opencode-router 1.1.0 → 1.1.1

package/README.md

@@ -1,6 +1,12 @@
 # opencode-router
 
-Automatic model routing for [OpenCode](https://opencode.ai) on the **Go**, **Go Plus**, and **Free** plans.
+[![npm version](https://img.shields.io/npm/v/@s-berdia/opencode-router)](https://www.npmjs.com/package/@s-berdia/opencode-router)
+[![npm downloads](https://img.shields.io/npm/dm/@s-berdia/opencode-router)](https://www.npmjs.com/package/@s-berdia/opencode-router)
+[![CI](https://github.com/s-berdia/Opencode_router/actions/workflows/ci.yml/badge.svg)](https://github.com/s-berdia/Opencode_router/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue)](./LICENSE)
+
+**Switch models before you hit your [OpenCode](https://opencode.ai) limit.** Automatic
+model routing and quota failover for the **Go**, **Go Plus**, and **Free** plans.
 
 ![opencode-router demo: the scorecard gives each agent a model, and the build agent changes to the next model at 85% of its 5-hour limit](docs/router-demo.gif)
 
@@ -41,6 +47,15 @@ the router, read its [known limits](./USAGE.md#11-known-limits).
 
 ## Quick start
 
+If you have the OpenCode command-line tool, run this command. Then close OpenCode, start
+it again, and go to step 4.
+
+```bash
+opencode plugin @s-berdia/opencode-router --global
+```
+
+If you do not have the command-line tool, edit the config file:
+
 1. Open your global OpenCode config file in a text editor:
    - Windows: `C:\Users\<your-user-name>\.config\opencode\opencode.json`
    - macOS and Linux: `~/.config/opencode/opencode.json`
@@ -210,6 +225,12 @@ To use your local build in OpenCode, put the absolute path of the folder in the
 list. Example for Windows: `"plugin": ["file:///C:/code/Opencode_router"]`. Run
 `npm run build` after each change, then restart OpenCode.
 
+## Contributing
+
+Bug reports, model scores, and code changes are welcome. Read
+[CONTRIBUTING.md](./CONTRIBUTING.md). For questions and ideas, use
+[Discussions](https://github.com/s-berdia/Opencode_router/discussions).
+
 ## License
 
 [MIT](./LICENSE)

package/USAGE.md

@@ -42,7 +42,22 @@ Make sure that you have these items:
 
 ## 2. Install the plugin
 
-### Option A: from npm (recommended)
+### Option A: with the OpenCode command-line tool (fastest)
+
+1. Run this command. It works in PowerShell, CMD, Git Bash, macOS, and Linux:
+
+   ```bash
+   opencode plugin @s-berdia/opencode-router --global
+   ```
+
+   The command downloads the plugin and adds `"@s-berdia/opencode-router"` to the
+   `plugin` list of your global config file.
+2. Close OpenCode. Start OpenCode again.
+
+If the `opencode` command is not found, use Option B. Or install the command-line tool
+with `npm install -g opencode-ai`, and then do step 1 again.
+
+### Option B: from npm, by hand
 
 1. Open the global OpenCode config file.
 
@@ -82,7 +97,7 @@ Make sure that you have these items:
 To use the router in one project only, put the `plugin` entry in `opencode.json` in the
 root folder of that project, not in the global file.
 
-### Option B: from source
+### Option C: from source
 
 Use this option to test changes to the code.
 
@@ -482,7 +497,7 @@ Do not commit the `router/` folder. It contains your usage data.
 
 ## 11. Known limits
 
-These are the limits of version 1.1.0.
+These are the limits of version 1.1.1.
 
 1. The router sets the model of the `plan`, `build`, `general`, and `explore` agents at
    each message. If you select a different model by hand, the router replaces it. To
@@ -544,7 +559,7 @@ To select the version yourself, write it in the `plugin` list:
 
 ```json
 {
-  "plugin": ["@s-berdia/opencode-router@1.1.0"]
+  "plugin": ["@s-berdia/opencode-router@1.1.1"]
 }
 ```
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@s-berdia/opencode-router",
-  "version": "1.1.0",
-  "description": "Dynamic model routing for OpenCode Go / Go Plus / Free. Picks the best value-for-money model per agent (plan, build, general, explore) and rotates automatically so a 24/7 build plan never runs out.",
+  "version": "1.1.1",
+  "description": "Automatic model routing and quota failover for OpenCode Go, Go Plus, and Free. Switches models before you hit your limit.",
   "type": "module",
   "license": "MIT",
   "author": "s-berdia",
@@ -16,9 +16,14 @@
   "keywords": [
     "opencode",
     "opencode-plugin",
-    "router",
+    "opencode-go",
     "model-routing",
-    "llm"
+    "failover",
+    "rate-limit",
+    "quota",
+    "llm",
+    "ai-coding",
+    "ai-agents"
   ],
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",