@chimix/agentscan 0.1.0 → 0.2.0

package/README.md

@@ -9,7 +9,8 @@
   <img src="https://img.shields.io/badge/tests-183%20passing-111111?style=flat-square" alt="183 tests">
   <img src="https://img.shields.io/badge/network-none-111111?style=flat-square" alt="No network">
   <img src="https://img.shields.io/badge/writes-none-111111?style=flat-square" alt="Writes nothing">
-  <img src="https://img.shields.io/badge/runtime-bun-111111?style=flat-square" alt="Bun">
+  <img src="https://img.shields.io/badge/runs%20on-node%20%C2%B7%20bun-111111?style=flat-square" alt="Node or Bun">
+  <img src="https://img.shields.io/npm/v/@chimix/agentscan?style=flat-square&color=111111&label=npm" alt="npm version">
   <img src="https://img.shields.io/badge/license-MIT-111111?style=flat-square" alt="MIT license">
 </p>
 
@@ -83,15 +84,22 @@ A check here has to point at a spec line. If it cannot, it does not ship.
 
 ## Try it in 30 seconds
 
-`agentscan` is **not on npm yet**, so `bunx agentscan` will 404. Clone and run it
-against any project — it reads that project, writes nothing, and never leaves
-your machine:
+Run it against any project. It reads that project, writes nothing, and never
+leaves your machine:
 
 ```bash
-git clone --depth=1 https://github.com/SimaAlexandru99/agentscan
-cd agentscan && bun install
+npx @chimix/agentscan@latest check ~/path/to/your-project
+```
+
+Works on Node 20.11+ or Bun — the published bin is a single bundled file with
+no dependencies to install. `bunx --bun @chimix/agentscan` is the same thing on
+Bun.
 
-bun run src/cli.ts check ~/path/to/your-project
+The package is scoped `@chimix/agentscan` because npm rejects the bare name as
+too close to an unrelated `agent-scan`. The command you type stays `agentscan`.
+
+```bash
+bun add -d @chimix/agentscan     # then: bunx agentscan check
 ```
 
 Point it at a project that actually has agent config — a `.claude/` directory,
@@ -100,22 +108,23 @@ correctly find nothing and say so.
 
 ```bash
 # what it could possibly report, before you run it
-bun run src/cli.ts rules
+bunx @chimix/agentscan rules
 
 # the interesting bits it hides by default
-bun run src/cli.ts check ~/your-project --verbose
+bunx @chimix/agentscan check ~/your-project --verbose
 
 # why one specific finding fired
-bun run src/cli.ts explain hook.missing-script:hook:PreToolUse:./x.js ~/your-project
+bunx @chimix/agentscan explain hook.missing-script:hook:PreToolUse:./x.js ~/your-project
 ```
 
-Requires **Bun** 1.1+. There is no Node build: the CLI uses `import.meta.dir`
-and `Bun.which` directly. `check` never opens a socket and never writes to the
-tree it scans.
+`check` never opens a socket and never writes to the tree it scans. Contributing
+needs **Bun** 1.1+ — the repo runs TypeScript directly and `bun run build`
+bundles it for Node.
 
 ### In CI
 
-The Action runs from its own checkout, so it works before the npm release:
+The Action runs from its own checkout, so it uses the ref you pin rather than
+whatever is on npm:
 
 ```yaml
 - uses: SimaAlexandru99/agentscan@v0
@@ -123,11 +132,12 @@ The Action runs from its own checkout, so it works before the npm release:
     fail-on: error
 ```
 
-### After the npm release
+### From a checkout
 
 ```bash
-bun add -d agentscan
-bunx agentscan check
+git clone --depth=1 https://github.com/SimaAlexandru99/agentscan
+cd agentscan && bun install
+bun run src/cli.ts check ~/your-project
 ```
 
 ## Usage