create-jant 0.3.15 → 0.3.17

package/dist/index.js

@@ -9,7 +9,7 @@ import path from "path";
 import { fileURLToPath } from "url";
 var __filename = fileURLToPath(import.meta.url);
 var __dirname = path.dirname(__filename);
-var CORE_VERSION = "0.3.15";
+var CORE_VERSION = "0.3.17";
 var TEMPLATE_DIR = fs.existsSync(path.resolve(__dirname, "../template")) ? path.resolve(__dirname, "../template") : path.resolve(__dirname, "../../../templates/jant-site");
 function isValidProjectName(name) {
   return /^[a-z0-9]([a-z0-9-]*[a-z0-9])?$/.test(name);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-jant",
-  "version": "0.3.15",
+  "version": "0.3.17",
   "description": "Create a new Jant project",
   "type": "module",
   "bin": {

package/template/README.md

@@ -2,29 +2,45 @@
 
 A personal website/blog powered by [Jant](https://github.com/jant-me/jant).
 
-## Local Development
+## Getting Started
+
+### Option A: One-Click Deploy
+
+Deploy to Cloudflare instantly — no local setup required:
+
+[![Deploy to Cloudflare](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/jant-me/jant-starter)
+
+Your site will be live with automatic CI/CD. To develop locally:
 
 ```bash
-pnpm dev
+# Clone the repo that was created for you
+git clone git@github.com:<your-username>/<your-repo>.git
+cd <your-repo>
+npm install
+npm run dev
 ```
 
-Visit http://localhost:9019 to see your site.
+Visit http://localhost:9019. Changes pushed to `main` will auto-deploy.
 
-## Deploy to Cloudflare
+> If you used this option, skip ahead to [Commands](#commands) — the deployment and CI/CD sections below don't apply to you.
 
-### Option A: One-Click Deploy
+### Option B: Create with CLI
 
-[![Deploy to Cloudflare](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/jant-me/jant-starter)
+Set up a new project locally, then deploy manually:
 
-Click the button, name your Worker, D1 database, and R2 bucket, set `AUTH_SECRET` (32+ random characters), and you're done!
+```bash
+npm create jant my-site
+cd my-site
+npm run dev
+```
 
-After deploying, set `SITE_URL` in Cloudflare dashboard → your Worker → Settings → Variables.
+Visit http://localhost:9019. When you're ready to go live, continue with [Deploy to Cloudflare](#deploy-to-cloudflare) below.
 
-> If you deployed via the button, skip to [Custom Domain](#custom-domain-optional).
+## Deploy to Cloudflare
 
-### Option B: Manual Deployment
+> This section is for **CLI-created projects** (Option B). One-click deploy users already have this set up.
 
-#### 1. Prerequisites
+### 1. Prerequisites
 
 Install [Wrangler CLI](https://developers.cloudflare.com/workers/wrangler/install-and-update/) and log in:
 
@@ -32,7 +48,7 @@ Install [Wrangler CLI](https://developers.cloudflare.com/workers/wrangler/instal
 wrangler login
 ```
 
-#### 2. Create D1 Database
+### 2. Create D1 Database
 
 Check the `database_name` in your `wrangler.toml` (defaults to `<your-project>-db`), then create it:
 
@@ -41,7 +57,7 @@ wrangler d1 create <your-project>-db
 # Copy the database_id from the output!
 ```
 
-#### 3. Update Configuration
+### 3. Update Configuration
 
 Edit `wrangler.toml`:
 
@@ -52,7 +68,7 @@ Edit `wrangler.toml`:
 >
 > **Note:** Changing `database_id` resets your local development database (local data is stored per database ID). If you've already started local development, you'll need to go through the setup wizard again to create your admin account.
 
-#### 4. Set Production Secrets
+### 4. Set Production Secrets
 
 Generate a production secret and save it somewhere safe (you'll need it again for CI):
 
@@ -65,18 +81,18 @@ wrangler secret put AUTH_SECRET
 # Paste the generated value when prompted
 ```
 
-> **Important:** This is separate from the `AUTH_SECRET` in `.dev.vars` (which is for local development only). Do not change the production secret after your site is live — it will invalidate all sessions. If you get locked out, use `pnpm reset-password` to generate a password reset link.
+> **Important:** This is separate from the `AUTH_SECRET` in `.dev.vars` (which is for local development only). Do not change the production secret after your site is live — it will invalidate all sessions. If you get locked out, use `npm run reset-password` to generate a password reset link.
 
-#### 5. Deploy
+### 5. Deploy
 
 ```bash
 # Apply database migrations and deploy
-pnpm run deploy
+npm run deploy
 ```
 
 Your site is now live at `https://<your-project>.<your-subdomain>.workers.dev`!
 
-### Custom Domain (Optional)
+### 6. Custom Domain (Optional)
 
 1. Go to [Cloudflare Dashboard](https://dash.cloudflare.com) → Workers & Pages
 2. Select your worker → Settings → Domains & Routes
@@ -84,7 +100,9 @@ Your site is now live at `https://<your-project>.<your-subdomain>.workers.dev`!
 
 ## GitHub Actions (CI/CD)
 
-A workflow file is included at `.github/workflows/deploy.yml`. Complete the [manual deployment](#option-b-manual-deployment) first, then set up CI for automatic deployments.
+> This section is for **CLI-created projects** (Option B). One-click deploy users already have CI/CD configured.
+
+A workflow file is included at `.github/workflows/deploy.yml`. Complete the [deployment](#deploy-to-cloudflare) first, then set up CI for automatic deployments.
 
 > Runtime secrets (`AUTH_SECRET`, S3 keys, etc.) are already stored in Cloudflare from the manual deployment step. CI only needs deployment credentials.
 
@@ -157,22 +175,16 @@ jobs:
       CF_ACCOUNT_ID: ${{ secrets.CF_ACCOUNT_ID }}
 ```
 
-### Cloudflare Workers Builds (Alternative CI/CD)
-
-Workers Builds is auto-configured if you used the [One-Click Deploy](#option-a-one-click-deploy) button. To enable auto-deploy on push, go to Cloudflare dashboard → Workers → your worker → Settings → Builds.
-
 ## Commands
 
-| Command                  | Description                        |
-| ------------------------ | ---------------------------------- |
-| `pnpm dev`               | Start development server           |
-| `pnpm build`             | Build for production               |
-| `pnpm run deploy`        | Migrate, build, and deploy         |
-| `pnpm preview`           | Preview production build           |
-| `pnpm typecheck`         | Run TypeScript checks              |
-| `pnpm db:migrate:remote` | Apply database migrations (remote) |
-
-> `deploy` uses `pnpm run deploy` because `pnpm deploy` is a built-in pnpm command. All other scripts work with or without `run`.
+| Command                     | Description                        |
+| --------------------------- | ---------------------------------- |
+| `npm run dev`               | Start development server           |
+| `npm run build`             | Build for production               |
+| `npm run deploy`            | Migrate, build, and deploy         |
+| `npm run preview`           | Preview production build           |
+| `npm run typecheck`         | Run TypeScript checks              |
+| `npm run db:migrate:remote` | Apply database migrations (remote) |
 
 ## Environment Variables
 
@@ -235,7 +247,7 @@ Add custom CSS in `src/theme/styles/`:
 ### Using Third-Party Themes
 
 ```bash
-pnpm add @jant-themes/minimal
+npm install @jant-themes/minimal
 ```
 
 ```typescript
@@ -251,13 +263,13 @@ export default createApp({
 
 ```bash
 # Update @jant/core to latest version
-pnpm add @jant/core@latest
+npm install @jant/core@latest
 
 # Start dev server (auto-applies migrations locally)
-pnpm dev
+npm run dev
 
 # Deploy (includes remote migrations)
-pnpm run deploy
+npm run deploy
 ```
 
 > New versions of `@jant/core` may include database migrations. Check the [release notes](https://github.com/jant-me/jant/releases) for any breaking changes.