@wipcomputer/wip-readme-format 1.9.17 → 1.9.18
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.
- package/README.md +20 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,10 +11,30 @@ Generate or validate READMEs that follow the WIP Computer standard. Badges, titl
|
|
|
11
11
|
- Same pattern as release notes: staging, review, deploy
|
|
12
12
|
- Validates existing READMEs against the standard
|
|
13
13
|
|
|
14
|
+
## Templates
|
|
15
|
+
|
|
16
|
+
All standard content lives in `ai/wip-templates/readme/`. Edit the templates, every tool picks up the changes. No code changes needed.
|
|
17
|
+
|
|
18
|
+
| Template | What it is |
|
|
19
|
+
|----------|-----------|
|
|
20
|
+
| `wip-lic-footer.md` | License section (plain text + markdown formats) |
|
|
21
|
+
| `cla.md` | Contributor License Agreement |
|
|
22
|
+
| `LICENSE.md` | Full dual MIT+AGPLv3 LICENSE file |
|
|
23
|
+
| `prompt.md` | Standard "Teach your AI" install prompt template |
|
|
24
|
+
|
|
25
|
+
Both `wip-readme-format` and `wip-license-guard` read from these templates at runtime.
|
|
26
|
+
|
|
14
27
|
## Usage
|
|
15
28
|
|
|
16
29
|
```bash
|
|
30
|
+
# Generate section files for review
|
|
17
31
|
node tools/wip-readme-format/format.mjs /path/to/repo
|
|
32
|
+
|
|
33
|
+
# Assemble sections into final README
|
|
34
|
+
node tools/wip-readme-format/format.mjs /path/to/repo --deploy
|
|
35
|
+
|
|
36
|
+
# Preview without writing
|
|
37
|
+
node tools/wip-readme-format/format.mjs /path/to/repo --dry-run
|
|
18
38
|
```
|
|
19
39
|
|
|
20
40
|
## Requirements
|