chore: add README

Author: Octane0411

.gitignore

@@ -2,3 +2,5 @@ node_modules
 dist
 .DS_Store
 *.tsbuildinfo
+opencode.json
+AGENTS.md

DESIGN.md

@@ -1,12 +1,86 @@
 # opencode-plugin-openspec
 
-An OpenCode plugin that integrates OpenSpec.
+An OpenCode plugin that integrates OpenSpec, providing a dedicated agent for planning and specifying software architecture.
 
 ## Features
 
-- **New Mode: `openspec-plan`**: A dedicated planning mode that allows creating and editing OpenSpec files (`*.spec.md`), while keeping the rest of the codebase read-only.
-- **Auto-Permission**: Automatically grants write permissions for openSpec files in `openspec-plan` mode.
+- **Auto-Detection**: Automatically detects if the current workspace is an OpenSpec project.
+- **New Agent: `openspec-plan`**: A dedicated agent mode for creating and editing OpenSpec files.
+- **Smart Permissions**: Automatically grants write permissions for:
+  - `project.md`
+  - `AGENTS.md`
+  - `openspec/**`
+  - `specs/**`
+- **Read-Only Safety**: Keeps the rest of the codebase read-only when using the `openspec-plan` agent, ensuring the implementation details are not accidentally modified during the planning phase.
 
 ## Installation
 
-(Instructions to be added)
+You don't need to build this plugin yourself. You can install it via npm or download the pre-built binary.
+
+### Option 1: Install via npm (Recommended)
+
+1. Install the plugin globally:
+   ```bash
+   npm install -g opencode-plugin-openspec
+   ```
+
+2. Add it to your `opencode.json` (usually in `~/.config/opencode/opencode.json` or `.opencode/opencode.json`):
+
+   ```json
+   {
+     "plugin": [
+       "opencode-plugin-openspec"
+     ]
+   }
+   ```
+   *(Note: If OpenCode doesn't support package names directly, you may need to provide the full path, e.g., `$(npm root -g)/opencode-plugin-openspec/dist/index.js`)*
+
+### Option 2: Download from Releases
+
+1. Go to the [Releases](https://github.com/yourusername/opencode-plugin-openspec/releases) page.
+2. Download the latest `index.js`.
+3. Place it anywhere on your disk.
+4. Add the path to your `opencode.json`:
+   ```json
+   {
+     "plugin": [
+       "/absolute/path/to/downloaded/index.js"
+     ]
+   }
+   ```
+
+## Usage
+
+1. Open an OpenSpec project in OpenCode.
+2. The plugin will automatically detect the project structure.
+3. Switch to the **OpenSpec Architect** agent (colored #FF6B6B) in the agent selector.
+4. Start planning your architecture! The agent will have access to modify your spec files while keeping your code safe.
+
+## Development
+
+If you want to contribute or modify the plugin, follow these steps:
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/yourusername/opencode-plugin-openspec.git
+   cd opencode-plugin-openspec
+   ```
+
+2. Install dependencies:
+   ```bash
+   bun install
+   ```
+
+3. Build the plugin:
+   ```bash
+   bun run build
+   ```
+
+4. Run watch mode for development:
+   ```bash
+   bun run watch
+   ```
+
+## License
+
+MIT

README.md

@@ -1,10 +1,15 @@
 {
   "name": "opencode-plugin-openspec",
   "version": "0.1.0",
+  "type": "module",
   "main": "src/index.ts",
   "peerDependencies": {
-    "@opencode-ai/plugin": "^1.1.1",
-    "@opencode-ai/sdk": "^1.1.1"
+    "@opencode-ai/plugin": "^1.1.19",
+    "@opencode-ai/sdk": "^1.1.19"
+  },
+  "scripts": {
+    "build": "bun build ./src/index.ts --outfile ./dist/index.js --target node",
+    "watch": "bun build ./src/index.ts --outfile ./dist/index.js --target node --watch"
   },
   "devDependencies": {
     "bun-types": "latest",

bun.lock

@@ -11,7 +11,6 @@ import { join } from "node:path";
  */
 export async function isOpenSpecProject(ctx: PluginInput): Promise<boolean> {
   const openspecAgentsPath = join(ctx.directory, "openspec", "AGENTS.md");
-  const rootAgentsPath = join(ctx.directory, "AGENTS.md");
 
-  return existsSync(openspecAgentsPath) || existsSync(rootAgentsPath);
+  return existsSync(openspecAgentsPath);
 }