yams-blackboard 1.0.4 → 1.1.0

package/README.md

@@ -1,5 +1,7 @@
 # YAMS Blackboard Plugin for OpenCode
 
+> **EXPERIMENTAL SOFTWARE** - This plugin is under active development. APIs may change without notice. Use at your own risk.
+
 A **blackboard architecture** plugin enabling agent-to-agent communication through [YAMS](https://github.com/trvon/yams) as shared memory.
 
 ## Overview
@@ -22,45 +24,39 @@ This plugin implements the classic [blackboard pattern](https://en.wikipedia.org
    └─────────┘        └─────────┘       └────────┘
 ```
 
-## Prerequisites
-
-- **[YAMS](https://github.com/trvon/yams)** - must be installed and daemon running
-- **bun** (for local development/building)
-- **OpenCode** v1.1.0+ (for plugin support)
-
 ## Installation
 
-### Option 1: npm (Recommended)
+### 1. Install YAMS
 
-Add to your `opencode.json`:
+Install the YAMS daemon from [github.com/trvon/yams](https://github.com/trvon/yams):
 
-```json
-{
-  "$schema": "https://opencode.ai/config.json",
-  "plugin": ["yams-blackboard"]
-}
-```
-
-OpenCode automatically installs npm plugins at startup.
+```bash
+# macOS
+brew install trvon/tap/yams
 
-### Option 2: Local Plugin
+# Or build from source (see YAMS repo for instructions)
+```
 
-Copy to your project's `.opencode/plugin/` directory:
+Start the daemon:
 
 ```bash
-mkdir -p .opencode/plugin/yams-blackboard
-cp -r * .opencode/plugin/yams-blackboard/
+yams daemon start
+yams status  # Should show "running"
 ```
 
-### Verify YAMS is Running
+### 2. Add Plugin to OpenCode
 
-The plugin communicates with YAMS via CLI. Ensure the daemon is running:
+Add to your `opencode.json`:
 
-```bash
-yams daemon start
-yams status
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "plugin": ["yams-blackboard"]
+}
 ```
 
+OpenCode automatically installs npm plugins at startup. No manual build or copy required.
+
 ## Tools
 
 ### Agent Management
@@ -213,38 +209,21 @@ Based on research into multi-agent communication patterns:
 - **A2A Protocol Concepts**: Structured findings with lifecycle states
 - **Task Coordination**: Claim-based work distribution with dependencies
 
-## Development
-
-### Building
+## Development (Contributors Only)
 
-Build with external dependencies (do not bundle zod or plugin SDK):
+This section is for contributors developing the plugin itself. Users should install via npm as described above.
 
 ```bash
-bun install
-bun run build
+bun install        # Install dependencies
+bun run build      # Compile index.ts to index.js
+bun run typecheck  # Type check
+bun test           # Run tests
 ```
 
-This compiles `index.ts` to `index.js` for distribution.
-
-### Type Checking
-
-```bash
-bun run typecheck
-```
-
-### Local Testing
-
-1. Build the plugin: `bun run build`
-2. Copy to your project: `cp index.js ~/.opencode/plugin/yams-blackboard.js`
-3. Restart OpenCode
-4. Test with: `bb_list_agents`
-
 ## Troubleshooting
 
 ### "YAMS daemon not running"
 
-Ensure the YAMS daemon is started:
-
 ```bash
 yams daemon start
 yams status  # Should show "running"
@@ -252,18 +231,18 @@ yams status  # Should show "running"
 
 ### "Command 'yams' not found"
 
-YAMS must be installed and in your PATH. Check your installation.
+YAMS must be installed and in your PATH. See [Installation](#installation).
 
 ### Plugin not loading
 
 1. Verify `opencode.json` has `"plugin": ["yams-blackboard"]`
-2. Check OpenCode logs for plugin load errors
-3. Try clearing npm cache: `npm cache clean --force`
+2. Restart OpenCode to load the plugin
+3. Check OpenCode logs for plugin errors
 
 ### Tools not appearing
 
-The plugin registers tools on `session.created`. Start a new session if tools don't appear.
+Start a new session - tools are registered on `session.created`.
 
 ## License
 
-MIT
+This project is licensed under the GNU General Public License v3.0 - see [LICENSE](LICENSE) for details.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yams-blackboard",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "description": "YAMS Blackboard plugin for OpenCode - agent-to-agent communication via shared memory",
   "main": "index.js",
   "types": "index.d.ts",