create-muten 0.0.1 → 0.0.2

package/README.md

@@ -1,14 +1,123 @@
 # create-muten
 
-Scaffold a new [Muten](https://www.npmjs.com/package/muten) app.
+The official scaffolder for **[Muten](https://www.npmjs.com/package/@muten/core)** — an AI-first
+frontend framework. One command bootstraps a complete, ready-to-run Muten app, so you never copy
+boilerplate by hand.
 
 ```sh
-npm create muten@latest      # or: npx create-muten
+npm create muten@latest
 ```
 
-It prompts for the **project name**, the **stylesheet** (CSS/SCSS) and the **package manager**
-(default = the one you invoked it with), then scaffolds and — unless you decline — runs
-`<pm> install` + `<pm> run dev`. CI flags: `--css|--scss`, `--pm <npm|pnpm|yarn|bun>`, `--no-install`.
+## Why this exists
 
-The engine (`@muten/core`) is a separate package the app installs as a dependency — the same split as
-`create-vue` ↔ `vue`. It's a Node CLI (not a shell script), so it behaves the same on Windows and macOS.
+Muten ships as **two** packages — the same split as `vue` ↔ `create-vue`:
+
+- **[`@muten/core`](https://www.npmjs.com/package/@muten/core)** — the engine (compiler + runtime +
+  Vite plugin). Your app installs it as a normal dependency and it stays up to date on its own.
+- **`create-muten`** (this package) — a tiny, **zero-dependency** CLI whose only job is to generate a
+  new project already wired to the engine: `index.html`, the Vite config, a `theme.muten`, a first
+  page and the right `package.json`.
+
+You run `create-muten` **once** to scaffold; after that you just work inside your project.
+
+## Quick start
+
+Every package manager has a `create` shortcut. `create-muten` detects which one you used and makes it
+the default for the rest of the prompts:
+
+```sh
+npm  create muten@latest        # npm
+pnpm create muten               # pnpm
+yarn create muten               # yarn
+bun  create muten               # bun
+```
+
+Prefer no install step? Run it on demand with **npx**, optionally naming the folder:
+
+```sh
+npx create-muten my-app
+```
+
+Or install it **globally** and reuse the command anywhere:
+
+```sh
+npm i -g create-muten
+create-muten my-app
+```
+
+Then start the app:
+
+```sh
+cd my-app
+npm install        # only if you skipped the auto-install
+npm run dev
+```
+
+## What it asks
+
+In an interactive terminal it prompts for a few things (defaults in parentheses):
+
+| Prompt | Options | Default |
+|---|---|---|
+| **Project name** | any valid folder name | `muten-app` |
+| **Stylesheet** | `css` / `scss` | `css` |
+| **Package manager** | `npm` / `pnpm` / `yarn` / `bun` | the one that launched it |
+| **Install deps and start dev now?** | `Y` / `n` | `Y` |
+
+If you accept the last prompt it runs `<pm> install` followed by `<pm> run dev` — your app is live in a
+single step. Choosing SCSS also adds `sass` and switches the stylesheet to `.scss` automatically.
+
+## Non-interactive (CI / scripts)
+
+Pass the answers as arguments and it skips every prompt (this is also what runs when there is no TTY,
+e.g. in CI):
+
+```sh
+create-muten my-app --scss --pm pnpm      # full control
+create-muten my-app --css --no-install    # just scaffold, decide later
+```
+
+| Flag | Effect |
+|---|---|
+| `<name>` | the project folder (positional argument) |
+| `--css` / `--scss` | pick the stylesheet (default: `css`) |
+| `--pm <npm\|pnpm\|yarn\|bun>` | package manager to use (default: detected) |
+| `--no-install` | scaffold only — don't install or start the dev server |
+| `--help` | print usage and exit |
+| `--version` | print the version and exit |
+
+## What you get
+
+A minimal, conventional Muten app:
+
+```
+my-app/
+├─ index.html              # entry — loads /src/app.muten through the Vite plugin
+├─ vite.config.mjs         # the @muten/core Vite plugin (dev server, HMR, routing)
+├─ theme.muten             # your design tokens: spacing, fonts, weights, breakpoints
+├─ package.json            # depends on @muten/core + vite
+└─ src/
+   ├─ app.muten            # the ROOT: routes (+ an optional persistent shell)
+   ├─ styles.css           # your look (.scss if you chose SCSS)
+   └─ pages/
+      └─ home/home.muten   # a page — the folder name is its route
+```
+
+There is **no hand-written `main.js`**: the Vite plugin compiles `src/app.muten` into the app's entry,
+so the whole app is `.muten` from the first line.
+
+## Requirements
+
+- **Node.js 18+**
+- One of: **npm**, **pnpm**, **yarn**, **bun**
+
+## Cross-platform
+
+`create-muten` is a Node CLI (not a shell script), so the **exact same command** works on **Windows,
+macOS and Linux** — npm generates the right launcher on each OS.
+
+## Links
+
+- Engine — [`@muten/core`](https://www.npmjs.com/package/@muten/core)
+- Source — [github.com/karttofer/create-muten](https://github.com/karttofer/create-muten)
+- License — MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-muten",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Scaffold a new Muten app.",
   "repository": {
     "type": "git",

package/template/package.json

@@ -8,7 +8,7 @@
     "lint": "muten lint"
   },
   "dependencies": {
-    "@muten/core": "^0.0.1",
+    "@muten/core": "^0.0.2",
     "vite": "^8.0.16"
   }
 }