roadmapsmith 0.1.0 → 0.1.1
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 +8 -55
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,36 +2,21 @@
|
|
|
2
2
|
|
|
3
3
|
Production-grade roadmap generator and sync tool for agent-driven projects.
|
|
4
4
|
|
|
5
|
-
## Install
|
|
5
|
+
## Install
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
### Primary install path: agent skill (available for private repository users)
|
|
10
|
-
|
|
11
|
-
```bash
|
|
12
|
-
npx skills add PapiScholz/roadmapsmith --skill roadmap-sync
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
This install command adds the `roadmap-sync` agent skill. It does not install the CLI package.
|
|
16
|
-
|
|
17
|
-
### Optional CLI package install (future, unavailable until npm publication)
|
|
7
|
+
### CLI
|
|
18
8
|
|
|
19
9
|
```bash
|
|
20
10
|
npm install -g roadmapsmith
|
|
21
11
|
```
|
|
22
12
|
|
|
23
|
-
###
|
|
13
|
+
### Agent Skill
|
|
24
14
|
|
|
25
15
|
```bash
|
|
26
|
-
|
|
27
|
-
node bin/cli.js --help
|
|
28
|
-
node bin/cli.js init --dry-run
|
|
29
|
-
node bin/cli.js generate --project-root . --dry-run --audit
|
|
16
|
+
npx skills add PapiScholz/roadmapsmith --skill roadmap-sync
|
|
30
17
|
```
|
|
31
18
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
The `roadmap-skill` CLI alias remains for backward compatibility and internal use, but public examples use `roadmapsmith`.
|
|
19
|
+
This adds the `roadmap-sync` agent skill. It does not install the CLI package.
|
|
35
20
|
|
|
36
21
|
## Commands
|
|
37
22
|
|
|
@@ -171,49 +156,17 @@ roadmapsmith sync --dry-run
|
|
|
171
156
|
npm test
|
|
172
157
|
```
|
|
173
158
|
|
|
174
|
-
## Publishing
|
|
175
|
-
|
|
176
|
-
### npm (public package, future)
|
|
177
|
-
|
|
178
|
-
1. Run tests.
|
|
159
|
+
## Publishing
|
|
179
160
|
|
|
180
161
|
```bash
|
|
181
162
|
npm test
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
2. Bump version using semver.
|
|
185
|
-
|
|
186
|
-
```bash
|
|
187
|
-
npm version patch
|
|
188
|
-
# or: npm version minor
|
|
189
|
-
# or: npm version major
|
|
190
|
-
```
|
|
191
|
-
|
|
192
|
-
3. Publish package.
|
|
193
|
-
|
|
194
|
-
```bash
|
|
163
|
+
npm version patch # or minor / major
|
|
195
164
|
npm publish --access public
|
|
196
|
-
```
|
|
197
|
-
|
|
198
|
-
4. Push tags.
|
|
199
|
-
|
|
200
|
-
```bash
|
|
201
165
|
git push origin main --follow-tags
|
|
202
166
|
```
|
|
203
167
|
|
|
204
|
-
### skills.sh / `npx skills add` discoverability (future)
|
|
205
|
-
|
|
206
|
-
1. After internal release-readiness is complete, make the repository public with `skills/roadmap-sync/SKILL.md` and `skills.json`.
|
|
207
|
-
2. Verify install flow from a clean project:
|
|
208
|
-
|
|
209
|
-
```bash
|
|
210
|
-
npx skills add PapiScholz/roadmapsmith --skill roadmap-sync
|
|
211
|
-
```
|
|
212
|
-
|
|
213
|
-
3. Confirm the installed skill appears in your agent skill list. This install command adds the agent skill, not the CLI package.
|
|
214
|
-
|
|
215
168
|
## Versioning Strategy
|
|
216
169
|
|
|
217
170
|
- `patch`: bug fixes and non-breaking validation/generation improvements.
|
|
218
171
|
- `minor`: backward-compatible features (new flags, new plugin hooks, additive config fields).
|
|
219
|
-
- `major`: breaking CLI/config behavior or marker/format changes.
|
|
172
|
+
- `major`: breaking CLI/config behavior or marker/format changes.
|