specforge-mcp 0.1.0 → 0.1.1

package/README.md

@@ -6,6 +6,8 @@
 ![License](https://img.shields.io/badge/license-MIT-blue)
 ![Node](https://img.shields.io/badge/node-%3E%3D22.0.0-green)
 
+📚 **[Documentation](https://specforge-mcp.vercel.app)** · 🇪🇸 **[Documentación en Español](https://specforge-mcp.vercel.app/es)**
+
 ## Installation
 
 ### Claude Desktop / Claude Code
@@ -41,6 +43,65 @@ Each transition is gated by DoR (Definition of Ready) and DoD (Definition of Don
 Constitution compliance is enforced automatically at `create_spec`, `audit`, and `detect_drift`.
 Spec versioning tracks every change and flags downstream spec impact when a dependency drifts.
 
+## Getting Started
+
+### 1. Initialize your project
+
+> "Initialize my project at /Users/me/my-app with specforge"
+
+SpecForge scans the directory and auto-detects your language, framework, package manager, and architecture style. It returns a `projectId` (e.g., `proj_abc123`) you'll use in all subsequent commands. No manual configuration needed.
+
+### 2. Create your first spec
+
+> "Create a spec for adding Google OAuth authentication to my project proj_abc123"
+
+SpecForge generates a full `HU.md` with acceptance criteria, a DoR checklist, database schema hints, and a step-by-step `PLAN.md`. All stored locally — no accounts, no cloud.
+
+### 3. Implement guided by the spec
+
+Claude uses the spec as a development contract while you code. When you're done, validate coverage:
+
+> "Validate spec SPEC-001 against the code at /Users/me/my-app/src"
+
+### 4. Detect drift
+
+As the codebase evolves, keep specs in sync:
+
+> "Check if my implementation matches SPEC-001 spec"
+
+SpecForge reports which criteria are covered, missing, or drifted — and flags downstream specs affected by the change.
+
+---
+
+## Use Cases
+
+### New feature
+```
+"Use specforge to create a spec for [feature] in project [id]"
+```
+
+### Audit dependencies
+```
+"Audit the stack of my project [id] and suggest improvements"
+```
+
+### Plan a migration
+```
+"Create a migration plan from Express to Fastify for project [id]"
+```
+
+### Reverse engineer existing code
+```
+"Reverse engineer my codebase at /path/to/project and generate specs"
+```
+
+### Detect tech debt
+```
+"Analyze tech debt in project [id]"
+```
+
+---
+
 ## Features
 
 ### A -- Configuration

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "specforge-mcp",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "SpecForge — MCP Server for Spec Driven Development. Manages specs, estimations, reverse engineering, and auto-learning across any language/framework.",
   "type": "module",
   "main": "dist/index.js",
@@ -14,25 +14,6 @@
   "engines": {
     "node": ">=22.0.0"
   },
-  "packageManager": "pnpm@10.28.2",
-  "scripts": {
-    "build": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json && node -e \"import('node:fs').then(({cpSync})=>cpSync('src/config','dist/config',{recursive:true}))\"",
-    "dev": "tsc --watch",
-    "start": "node dist/index.js",
-    "clean": "rm -rf dist",
-    "lint": "eslint src/ tests/ --max-warnings 0",
-    "lint:fix": "eslint src/ tests/ --fix --max-warnings 0",
-    "format": "prettier --write 'src/**/*.ts' 'tests/**/*.test.ts'",
-    "format:check": "prettier --check 'src/**/*.ts' 'tests/**/*.test.ts'",
-    "typecheck": "tsc --noEmit",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "test:coverage": "vitest run --coverage",
-    "check": "pnpm typecheck && pnpm lint && pnpm format:check",
-    "setup:protection": "bash scripts/setup-branch-protection.sh",
-    "prepare": "husky || true",
-    "prepublishOnly": "pnpm build"
-  },
   "lint-staged": {
     "src/**/*.ts": [
       "eslint --fix --max-warnings 0",
@@ -46,6 +27,7 @@
       "prettier --write"
     ]
   },
+  "homepage": "https://specforge-mcp.vercel.app",
   "keywords": [
     "mcp",
     "specforge",
@@ -79,5 +61,21 @@
     "typescript": "^5.7.0",
     "typescript-eslint": "^8.56.1",
     "vitest": "^4.0.18"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json && node -e \"import('node:fs').then(({cpSync})=>cpSync('src/config','dist/config',{recursive:true}))\"",
+    "dev": "tsc --watch",
+    "start": "node dist/index.js",
+    "clean": "rm -rf dist",
+    "lint": "eslint src/ tests/ --max-warnings 0",
+    "lint:fix": "eslint src/ tests/ --fix --max-warnings 0",
+    "format": "prettier --write 'src/**/*.ts' 'tests/**/*.test.ts'",
+    "format:check": "prettier --check 'src/**/*.ts' 'tests/**/*.test.ts'",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "check": "pnpm typecheck && pnpm lint && pnpm format:check",
+    "setup:protection": "bash scripts/setup-branch-protection.sh"
   }
-}
+}