@skafform/create 0.2.0 → 0.2.1

package/README.md

@@ -0,0 +1,78 @@
+# create-skafform
+
+Scaffold a new [Skafform](https://github.com/skafform) project with Next.js or Nuxt, pre-configured with security headers, CSP, and the Skafform module system.
+
+## Usage
+
+```bash
+npm create @skafform@latest <project-name> [next|nuxt]
+```
+
+## Options
+
+| Argument | Description |
+|----------|-------------|
+| `next` | Scaffold a Next.js project (default) |
+| `nuxt` | Scaffold a Nuxt project _(coming soon)_ |
+| `-v, --version` | Show version number |
+| `-h, --help` | Show help message |
+
+## Examples
+
+```bash
+# Next.js (default)
+npm create @skafform@latest my-app
+
+# Next.js (explicit)
+npm create @skafform@latest my-app next
+
+# Nuxt (coming soon)
+npm create @skafform@latest my-app nuxt
+```
+
+## What's included
+
+### Next.js
+- Next.js with TypeScript, Tailwind CSS, ESLint, and App Router
+- Content Security Policy (CSP) via `next.config.ts`
+- Security headers: `X-Frame-Options`, `X-Content-Type-Options`, `Referrer-Policy`, `Permissions-Policy`
+- Middleware proxy via `proxy.ts` with `beforeAuth` / `afterAuth` hooks
+- `Providers` wrapper in `app/layout.tsx`
+
+### Project structure
+
+```
+my-app/
+├── .skafform/
+│   ├── contracts/       # Skafform module contracts
+│   ├── modules/         # Installed module overrides
+│   ├── installed.json   # Installed modules registry
+│   ├── csp.ts           # CSP builder (managed)
+│   ├── proxy.ts         # Middleware logic (managed)
+│   └── providers.tsx    # React providers (managed)
+├── proxy.ts             # User-owned middleware entry point
+└── ...
+```
+
+## After scaffolding
+
+```bash
+cd my-app
+npm run dev
+```
+
+To add integrations:
+
+```bash
+npx skafform serve
+```
+
+## Project name rules
+
+Only lowercase letters, numbers, hyphens, and underscores are allowed.
+
+```bash
+my-app      # valid
+my_app      # valid
+MyApp       # invalid
+```

package/dist/index.js

@@ -12,25 +12,26 @@ if (process.argv[2] === "--version" || process.argv[2] === "-v") {
 }
 if (process.argv[2] === "--help" || process.argv[2] === "-h") {
     console.log(`
-Usage: create-skafform <project-name> [--next|--nuxt]
+Usage: create-skafform <project-name> [next|nuxt]
 
 Options:
-  --next          Scaffold a Next.js project (default)
-  --nuxt          Scaffold a Nuxt project
+  next            Scaffold a Next.js project (default)
+  nuxt            Scaffold a Nuxt project
   -v, --version   Show version number
   -h, --help      Show this help message
 
 Examples:
-  npx create-skafform my-app --next
-  npx create-skafform my-app --nuxt
+  npm create @skafform@latest my-app
+  npm create @skafform@latest my-app next
+  npm create @skafform@latest my-app nuxt
 `);
     process.exit(0);
 }
 const name = process.argv[2];
-const flags = process.argv.slice(3);
-const isNuxt = flags.includes("--nuxt");
+const framework = process.argv[3];
+const isNuxt = framework === "nuxt";
 if (!name) {
-    console.error("Usage: npx create-skafform <project-name> [--next|--nuxt]");
+    console.error("Usage: npm create @skafform@latest <project-name> [next|nuxt]");
     process.exit(1);
 }
 if (!/^[a-z0-9-_]+$/.test(name)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skafform/create",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Scaffold a new Skafform project",
   "bin": {
     "create-skafform": "./dist/index.js"