diff --git a/README.md b/README.md index 538bf50..df30c5e 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,41 @@ -# Tools +# OpenClaw Tools (`openclaw-plugin-tools`) -Simple OpenClaw tool plugin. +Collection of custom tools and bundled skills for OpenClaw. -## Build +## Step-by-Step Construction History + +1. **Step 1 — Initialize Scaffold (`chore: openclaw plugins init tools`)** + Generated the standard plugin skeleton via `openclaw plugins init tools`. +2. **Step 2 — Compile & Build Metadata (`build: compile TypeScript to dist and add .gitignore`)** + Compiled `src/index.ts` into `dist/index.js` and ran `openclaw plugins build --entry ./dist/index.js` so downstream installs do not require a local build step. +3. **Step 3 — Enable Multi-Skill Bundling (`feat: enable bundled skills directory in openclaw.plugin.json`)** + Added `"skills": ["./skills"]` to `openclaw.plugin.json` and `"skills"` to `package.json#files` so OpenClaw discovers all skills placed under `skills//SKILL.md`. +4. **Step 4 — Bundle First Skill (`feat(skills): bundle bitwarden agent-access skill`)** + Added `skills/agent-access/SKILL.md` for Bitwarden Agent Access (`aac`). +5. **Step 5 — Documentation (`docs: document step-by-step plugin construction and usage`)** + Documented project layout and installation workflow. + +## Project Structure + +```text +openclaw-plugin-tools/ +├── openclaw.plugin.json # Plugin manifest (declares tools & skills dir) +├── package.json # Package metadata & entrypoints +├── src/ +│ ├── index.ts # Tool plugin TypeScript source +│ └── index.test.ts # Unit tests +├── dist/ # Pre-compiled JS artifacts +└── skills/ # Bundled skills directory + └── agent-access/ + └── SKILL.md # Bitwarden Agent Access skill +``` + +## Installation & Update ```bash -npm install -npm run plugin:build +# Install from Gitea +openclaw plugins install git:git.1-h.cc/OpenClaw/openclaw-plugin-tools --force + +# Validate plugin npm run plugin:validate -npm test ```