@bonesofspring/ai-rules 0.1.2 → 0.1.3

package/README.md

@@ -0,0 +1,31 @@
+# @bonesofspring/ai-rules
+
+Presets for Cursor and Claude Code: rules, commands, plus for Claude `CLAUDE.md` and `skills` / `agents` / `hooks` when the preset includes them. Install from npm into a project so you don’t have to copy files out of the repo by hand.
+
+Node 18+.
+
+```bash
+# from the project root
+npx @bonesofspring/ai-rules init cursor --preset next
+npx @bonesofspring/ai-rules init claude --preset next
+```
+
+Global: `npm i -g @bonesofspring/ai-rules`, then `ai-rules ...`.
+
+`init` merges into the current directory: dirs are created, matching files are **overwritten**. `--preset` and the subcommand can be in either order, e.g. `--preset=next init cursor`.
+
+`clean cursor` / `clean claude` removes what this CLI installs: for Cursor, `.cursor/rules` and `.cursor/commands`; for Claude also `.claude/skills`, `agents`, `hooks`, and `CLAUDE.md` when those were present. Anything else under `.cursor` / `.claude` is left alone.
+
+Where things go on `init`:
+
+| | Cursor | Claude |
+|---|--------|--------|
+| rules | `.cursor/rules` | `.claude/rules` |
+| commands | `.cursor/commands` | `.claude/commands` |
+| other | — | root `CLAUDE.md` → `.claude/CLAUDE.md`; folders `skills`, `agents`, `hooks` → under `.claude/` with the same names |
+
+The package currently ships the **`next`** preset (Next.js stack and whatever else is bundled there). Other preset names: see `presets/` in the [repo](https://github.com/bonesofspring/ai-rules). Name is a single path segment, no `/` or `..`.
+
+Help: `ai-rules --help`.
+
+MIT.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bonesofspring/ai-rules",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Presets of Cursor and Claude rules/commands for Revy Ross personal use",
   "license": "MIT",
   "author": "Revy Ross",
@@ -19,6 +19,7 @@
     "ai-rules": "./bin/cli.js"
   },
   "files": [
+    "README.md",
     "bin",
     "presets"
   ],