create-dokio 0.1.15 → 0.1.16

package/README.md

@@ -2,59 +2,78 @@
 
 CLI scaffold for Dokio hub repos and templates. Generates correct file structure, `data.yaml`, HTML boilerplate, SCSS partials, and auto-wires changelog tooling.
 
-## Usage
+---
+
+## Getting started
+
+Run from your **repos workspace folder** — the folder where all your hub repos live (e.g. `~/Projects/dokio/`).
+
+No install needed. Just run:
 
 ```bash
-# Interactive — prompts for everything
 npx --yes create-dokio@latest
-
-# Pre-fill the template name
-npx --yes create-dokio@latest pool-care
 ```
 
-> Using pnpm? `pnpm dlx create-dokio`
-
-Run from your **repos workspace folder** — the folder where all your hub repos live (e.g. `~/Projects/dokio/`).
+The `--yes` flag skips the "Ok to proceed?" prompt. The `@latest` tag ensures you always run the newest version — no separate update step needed.
 
 ---
 
-## Keeping up to date
-
-`npx` caches packages locally, so `npx create-dokio` may run an old version even after an update is published.
+## Running the CLI
 
-**Always use `@latest` to get the newest version:**
+### Interactive (recommended)
 
 ```bash
 npx --yes create-dokio@latest
 ```
 
-The `--yes` flag skips the "Ok to proceed?" install prompt.
+Prompts you to choose between creating a Template or a Hub.
 
-**Check what version is available on npm:**
+### Direct commands
 
 ```bash
-npm show create-dokio version
+# Go straight to template creation
+npx --yes create-dokio@latest template
+
+# Go straight to hub creation
+npx --yes create-dokio@latest hub
 ```
 
-**Check what version you have cached:**
+### Check version
 
 ```bash
-npx create-dokio@latest --version
+npx --yes create-dokio@latest --version
 ```
 
-> If Jake tells you there's an update, run `npx --yes create-dokio@latest` and you're on the new version immediately.
+### Using pnpm instead of npx
+
+```bash
+pnpm dlx create-dokio
+```
 
 ---
 
 ## Commands
 
-### `create-dokio hub`
+### `create-dokio template`
 
-Creates a new hub repository locally with full structure ready to push.
+Scaffolds a new template inside an existing hub repo. Automatically clones the hub if not found locally, or pulls latest if it is.
 
-```bash
-npx create-dokio hub
-```
+**Prompts:**
+- Template ID (e.g. `HW485`)
+- Template name (e.g. `My Cool Template`)
+- Template type — PDF, General, Email, or Video
+- Hub selection
+
+**What it does:**
+- Clones or pulls the hub repo
+- Scaffolds the template folder inside `<hub-id>-templates/templates/`
+- Auto-repairs any missing hub tooling (changelog script, hooks, `.vscode`, `.gitignore`, `README.md`)
+
+---
+
+### `create-dokio hub`
+
+Creates a new hub repository locally with full structure, ready to push to GitHub.
 
 **Prompts:**
 - Hub ID (kebab-case, e.g. `bupa-sam`)
@@ -82,7 +101,8 @@ bupa-sam-templates/
 
 ```bash
 cd bupa-sam-templates
-# Create GitHub repo at github.com/dokioco/bupa-sam-templates
+
+# Create the GitHub repo at github.com/dokioco/bupa-sam-templates, then:
 git remote add origin https://github.com/dokioco/bupa-sam-templates
 git push -u origin main
 
@@ -93,33 +113,14 @@ cp tools/changelog/.env.example tools/changelog/.env
 
 ---
 
-### `create-dokio template`
-
-Scaffolds a new template inside an existing hub repo. Clones the hub if not found locally.
-
-```bash
-npx create-dokio template
-# or just:
-npx create-dokio
-```
-
-**Prompts:**
-- Template ID (e.g. `HW485`)
-- Template name (e.g. `My Cool Template`)
-- Template type (PDF / General / Email / Video)
-- Hub selection
-
-If the hub repo exists locally, it pulls latest. If not, it clones it.
-
-If the hub is missing any tooling (changelog script, hooks, `.vscode`, `.gitignore`, `README.md`), it adds them automatically.
-
----
-
 ## Template types
 
 ### PDF
 PrinceXML-rendered print documents. Supports multi-page, resizable layouts, orderable exports, and proof downloads.
 
+**Prompts:** page dimensions (mm), page count, PrinceXML version (11 or 15), resizable, proof downloads, orderable export.
+
+**Generates:**
 ```
 HW485-my-cool-template/
 ├── CHANGELOG.md
@@ -139,8 +140,6 @@ HW485-my-cool-template/
         └── _page2.scss
 ```
 
-**Prompts:** page dimensions (mm), page count, PrinceXML version (11 or 15), resizable, proof downloads, orderable export.
-
 ---
 
 ### General (image)
@@ -162,30 +161,17 @@ HTML email scaffold. Includes Outlook conditional comments, `{{{___assembled_css
 
 ---
 
-## Changelog generator
-
-Each template has its own `CHANGELOG.md`. After every commit that touches a template folder, the `post-commit` hook automatically:
-
-1. Detects which templates changed
-2. Logs the commit to each affected template's `CHANGELOG.md` (author, date, branch, title, files with status labels)
-3. Amends the commit silently to include the changelog update
-
-**Description generation:**
-- If `tools/changelog/.env` exists with a valid `ANTHROPIC_API_KEY` → Claude Haiku generates a description
-- If no key → falls back to `TODO - INTEGRATE WITH AI (JAKE TASK)`
-
----
-
 ## After scaffolding a template
 
 ```bash
+# Navigate to the template folder
 cd bupa-sam-templates/templates/HW485-my-cool-template
 
-# 1. Check data.yaml — name and subdomain are auto-set
+# 1. Check data.yaml — name and subdomain are auto-set, verify they're correct
 # 2. Add assets to assets/
 # 3. Edit partials/
 
-# When ready to commit (from hub root):
+# When ready to commit — go back to the hub root first:
 cd ../../
 git add templates/HW485-my-cool-template/
 git commit -m "feat: add My Cool Template"
@@ -194,6 +180,48 @@ git push
 
 ---
 
+## Changelog generator
+
+Each template has its own `CHANGELOG.md`. The `post-commit` hook runs automatically after every commit and:
+
+1. Detects which template folders changed
+2. Logs the commit to each affected template's `CHANGELOG.md` (author, date, branch, title, files with Added/Modified/Deleted labels)
+3. Amends the commit silently to include the changelog update
+
+**AI descriptions:**
+- With `ANTHROPIC_API_KEY` in `tools/changelog/.env` → Claude Haiku generates a summary
+- Without key → entry is logged without a description
+
+---
+
+## Updating
+
+Always use `@latest` when running the CLI — you're always on the newest version automatically. No separate update step.
+
+```bash
+npx --yes create-dokio@latest
+```
+
+**Check what version is on npm:**
+
+```bash
+npm show create-dokio version
+```
+
+---
+
+## Removing
+
+If you ever installed `create-dokio` globally (via `npm install -g`), remove it with:
+
+```bash
+npm uninstall -g create-dokio
+```
+
+npx users have nothing to uninstall — npx doesn't permanently install packages.
+
+---
+
 ## Development
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-dokio",
-  "version": "0.1.15",
+  "version": "0.1.16",
   "description": "CLI scaffold for Dokio templates",
   "type": "module",
   "bin": {