@wipcomputer/wip-readme-format 1.9.14 → 1.9.17
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 +29 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
###### WIP Computer
|
|
2
|
+
|
|
3
|
+
# README Formatter
|
|
4
|
+
|
|
5
|
+
Generate or validate READMEs that follow the WIP Computer standard. Badges, title, tagline, "Teach Your AI" block, features, interface coverage table, license.
|
|
6
|
+
|
|
7
|
+
## What it does
|
|
8
|
+
|
|
9
|
+
- Generates separate section files (README-init-badges.md, README-init-features.md, etc.) so you can edit any section independently
|
|
10
|
+
- Deploy assembles them into the final README
|
|
11
|
+
- Same pattern as release notes: staging, review, deploy
|
|
12
|
+
- Validates existing READMEs against the standard
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
node tools/wip-readme-format/format.mjs /path/to/repo
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Requirements
|
|
21
|
+
|
|
22
|
+
- node (18+)
|
|
23
|
+
|
|
24
|
+
## Interfaces
|
|
25
|
+
|
|
26
|
+
- **CLI**: Command-line tool
|
|
27
|
+
- **Skill**: SKILL.md for agent instructions
|
|
28
|
+
|
|
29
|
+
## Part of [AI DevOps Toolbox](https://github.com/wipcomputer/wip-ai-devops-toolbox)
|