craftassay 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +29 -14
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -9,33 +9,48 @@ An installable review skill for AI agents.
9
9
  An assay tests what something is made of, and how good it is.
10
10
  CraftAssay does that for a tool, a site, or a page. It writes
11
11
  findings and scores that can be compared across revisions.
12
- npm **`craftassay`**.
13
12
 
14
13
  The report is an assessment, not a certification.
15
14
 
16
- **Docs:** [craftassay.dev/docs](https://craftassay.dev/docs) · **Site:** [craftassay.dev](https://craftassay.dev)
15
+ **Get started:** pick the agent, install the skill, then run the
16
+ HarborNote page —
17
+ [craftassay.dev/docs/install](https://craftassay.dev/docs/install).
17
18
 
18
- ## Review, then decide
19
+ - [Cursor](https://craftassay.dev/docs/install#cursor)
20
+ - [Claude Code](https://craftassay.dev/docs/install#claude-code)
21
+ - [Claude.ai](https://craftassay.dev/docs/install#claudeai)
19
22
 
20
- Submit a tool, a site, a skill, a spec, or a portfolio. The agent
21
- writes a dated run folder with `report.md` plus a scorecard,
22
- findings, and coverage. The skill does not edit the source.
23
+ **Site:** [craftassay.dev](https://craftassay.dev)
23
24
 
24
- A later pass with the earlier report attached becomes a comparison.
25
- It does not overwrite the earlier folder.
25
+ ## First run
26
26
 
27
- ## Install
27
+ Save a short page that says nothing leaves the machine and also
28
+ promises automatic sync, then ask:
29
+
30
+ > Use CraftAssay on `harbor-note.md`. Follow the installed CraftAssay
31
+ > skill. Write the report.
32
+
33
+ The run lands in `harbor-note.craftassay/<YYYY-MM-DD>/`. The page
34
+ should be unchanged. The report should name the privacy contradiction.
35
+
36
+ The package does not run an automatic scanner. The reviewing agent
37
+ may inspect project files you point it at. v1 has no CLI.
38
+
39
+ ## Other installation methods
40
+
41
+ npm supplies the skill files. It does not register the skill with the
42
+ agent.
28
43
 
29
44
  ```bash
30
45
  pnpm add -D craftassay
31
46
  ```
32
47
 
33
- Copy `node_modules/craftassay/skills/craftassay/` to
34
- `.cursor/skills/craftassay`. Or skip npm and
35
- [install the skill](https://craftassay.dev/docs/install) as a folder.
48
+ Copy `node_modules/craftassay/skills/craftassay/` into the same
49
+ destination the [Get started](https://craftassay.dev/docs/install)
50
+ page names for your agent.
36
51
 
37
- The package does not run an automatic scanner. The reviewing agent
38
- may inspect project files you point it at. v1 has no CLI.
52
+ Updating the npm dependency does not refresh a folder you already
53
+ copied. Copy again after you bump the package.
39
54
 
40
55
  ## CraftAssay and Cold-eye
41
56
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "craftassay",
3
- "version": "0.1.3",
3
+ "version": "0.1.4",
4
4
  "private": false,
5
5
  "type": "module",
6
6
  "description": "Evidence-backed reviews of usefulness, clarity, quality, and presentation. An agent with the skill writes the report.",