create-jant 0.3.16 → 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.16";
+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.16",
+  "version": "0.3.17",
   "description": "Create a new Jant project",
   "type": "module",
   "bin": {

package/template/README.md

@@ -2,25 +2,43 @@
 
 A personal website/blog powered by [Jant](https://github.com/jant-me/jant).
 
-**Want your own site?** Deploy to Cloudflare in one click:
+## 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)
 
-> Already deployed? Your site is live with automatic CI/CD. You can clone your repo and run `pnpm dev` to customize or [update](#updating) your site locally.
+Your site will be live with automatic CI/CD. To develop locally:
 
-## Getting Started
+```bash
+# 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. Changes pushed to `main` will auto-deploy.
+
+> If you used this option, skip ahead to [Commands](#commands) — the deployment and CI/CD sections below don't apply to you.
+
+### Option B: Create with CLI
+
+Set up a new project locally, then deploy manually:
 
 ```bash
-pnpm create jant my-site
+npm create jant my-site
 cd my-site
-pnpm dev
+npm run dev
 ```
 
-Visit http://localhost:9019 to see your site.
+Visit http://localhost:9019. When you're ready to go live, continue with [Deploy to Cloudflare](#deploy-to-cloudflare) below.
 
 ## Deploy to Cloudflare
 
-Once you've run `pnpm create jant my-site`, follow these steps to deploy it.
+> This section is for **CLI-created projects** (Option B). One-click deploy users already have this set up.
 
 ### 1. Prerequisites
 
@@ -63,13 +81,13 @@ 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
 
 ```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`!
@@ -82,6 +100,8 @@ Your site is now live at `https://<your-project>.<your-subdomain>.workers.dev`!
 
 ## GitHub Actions (CI/CD)
 
+> 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,16 +177,14 @@ jobs:
 
 ## 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
 
@@ -229,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
@@ -245,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.