@karaoke-cms/enrich 0.9.3 → 0.9.6

package/README.md

@@ -1,48 +1,36 @@
 # @karaoke-cms/enrich
 
-AI enrichment pipeline for karaoke-cms. Reads published vault content and writes AI-generated metadata (reading time, tags, description, related posts) back into frontmatter.
+AI enrichment pipeline for karaoke-cms. Reads published vault content and writes AI-generated metadata (`reading_time`, `tags`, `description`, `related`) back into frontmatter.
 
-## Where it belongs
+## Usage
 
-`packages/enrich/` in the monorepo. Runs as a pre-commit hook — not in CI:
-
-```bash
-# .githooks/pre-commit
-node scripts/enrich.js --staged
-```
-
-Or manually against the full vault:
+Runs as a pre-commit hook — not in CI:
 
 ```bash
+# triggered automatically on git commit
+# or run manually:
 node scripts/enrich.js
 ```
 
-Requires `ANTHROPIC_API_KEY` or `OPENAI_API_KEY` in the environment (or `.env`).
+Requires `ANTHROPIC_API_KEY` or `OPENAI_API_KEY` in the environment or `.env`.
 
 ## What it does
 
-For each published Markdown file in the vault that has not been enriched yet (or whose body has changed since last enrichment):
-
-1. **Reading time** — counts words, estimates minutes at 200 wpm, writes `reading_time` to frontmatter
-2. **Tags** — asks the AI to suggest 3–5 tags; writes `tags` array to frontmatter
-3. **Description** — asks the AI for a one-sentence summary; writes `description` to frontmatter
-4. **Related posts** — computes overlap between tag arrays across all posts; writes `related` array (slugs) to frontmatter
+For each published Markdown file that hasn't been enriched yet (or whose body has changed):
 
-Supported AI providers: Anthropic Claude and OpenAI GPT. Provider is selected based on which API key is present.
+1. **Reading time** — counts words, writes `reading_time` in minutes
+2. **Tags** — asks the AI for 3–5 tags, writes `tags` array
+3. **Description** — asks the AI for a one-sentence summary, writes `description`
+4. **Related posts** — computes tag overlap across all posts, writes `related` (slugs)
 
-Results are cached in `.enrich-cache.json` (gitignored) — files are skipped if their body hash has not changed. A per-run cap (`MAX_ENRICHMENTS_PER_RUN`) prevents runaway API costs.
+Results are cached in `.enrich-cache.json` (gitignored) — unchanged files are skipped. A per-run cap prevents runaway API costs.
 
 **Privacy gate**: only processes files with `publish: true`. Private vault notes are never sent to an AI provider.
 
 ## Status
 
-**Stub** — the package entry point (`bin/enrich`) is declared but the implementation has not yet been migrated from `apps/template/scripts/enrich.js`. Until migration is complete, use the script directly from your project's `scripts/` directory.
-
-The canonical implementation is at `apps/template/scripts/enrich.js` in this monorepo and at `scripts/enrich.js` in scaffolded projects.
+**Stub** — the package placeholder is installed by scaffolded projects. The implementation lives at `scripts/enrich.js` in your project directory.
 
-## How it changes the behavior of the system
+## What's new in 0.9.5
 
-- Enrichment is additive and non-destructive — it only writes fields that are absent or stale. Manually written frontmatter values are never overwritten.
-- Enriched fields (`reading_time`, `tags`, `description`, `related`) are consumed by theme components: reading time appears on post cards, tags power the `/tags` routes, related posts appear in the post sidebar.
-- The pre-commit hook means enrichment runs automatically on staged content — authors never need to think about it.
-- Enrichment is disabled in CI by default (`ENRICH_ENABLED` env var). It runs locally on the author's machine, so enriched frontmatter is committed alongside the content.
+No user-facing changes in this release — version bumped for lockstep with the monorepo.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@karaoke-cms/enrich",
   "type": "module",
-  "version": "0.9.3",
+  "version": "0.9.6",
   "description": "AI enrichment pipeline for karaoke-cms",
   "keywords": [
     "astro",
@@ -14,6 +14,6 @@
     "openai": ">=6.0.0"
   },
   "scripts": {
-    "test": "echo \"No tests yet — source lives in apps/template/scripts/\""
+    "test": "echo \"No tests yet — source lives in apps/website/scripts/\""
   }
 }