create-clientkit 1.0.1 → 1.0.2

package/README.md

@@ -1,22 +1,37 @@
 # create-clientkit
 
+[![npm](https://img.shields.io/npm/v/create-clientkit)](https://www.npmjs.com/package/create-clientkit)
+[![CI](https://github.com/JosuK22/create-clientkit/actions/workflows/ci.yml/badge.svg)](https://github.com/JosuK22/create-clientkit/actions/workflows/ci.yml)
+[![node](https://img.shields.io/node/v/create-clientkit)](https://nodejs.org)
+[![licence](https://img.shields.io/npm/l/create-clientkit)](./LICENSE)
+
 **Create the boring foundation of your next client website in seconds.**
 
+```sh
+npm create clientkit@latest acme-website
+```
+
 A scaffolding CLI for developers who build client websites over and over:
 freelancers, agencies and frontend teams. It generates the foundation you
-rebuild every time — layout, Coming Soon page, 404, SEO, robots, sitemap,
-structured data, favicon, accessibility baseline, build config — and then gets
-out of the way.
+rebuild every time — layout, a Coming Soon page, a custom 404, SEO metadata,
+`robots.txt`, a sitemap, structured data, a favicon, an accessibility baseline
+and build config — and then gets out of the way.
 
 It is **not** a website builder. You own the generated source from the moment
 it lands on disk.
 
-```sh
-npm create clientkit@latest acme-website
-```
+**What it generates** — a static [Astro](https://astro.build) 7 +
+[Tailwind CSS](https://tailwindcss.com) 4 site in TypeScript: responsive, light
+and dark themes, and no client-side JavaScript by default. Start in
+**Coming Soon** mode for a launch page, **Full** for a small multi-section home
+page, or **URL-less** when the domain is not decided yet.
 
-[![npm](https://img.shields.io/npm/v/create-clientkit)](https://www.npmjs.com/package/create-clientkit)
-[![CI](https://github.com/JosuK22/create-clientkit/actions/workflows/ci.yml/badge.svg)](https://github.com/JosuK22/create-clientkit/actions/workflows/ci.yml)
+**What it is** — one bundled CLI with **zero runtime dependencies**, MIT
+licensed, published from CI with
+[provenance](https://docs.npmjs.com/generating-provenance-statements) and
+tested on Linux, Windows and macOS across Node 20.19, 22 and 24. The site it
+generates has its own dependencies — Astro and Tailwind, pinned exactly — which
+is a separate thing from the CLI's own dependency count.
 
 ---
 
@@ -48,11 +63,24 @@ and warns before generating that the project itself will need 22.12+.
 
 ## Usage
 
+Recommended — nothing to install first, and `@latest` sidesteps npm's
+initializer cache:
+
 ```sh
 npm create clientkit@latest [directory] [options]
+```
+
+The same binary is reachable through `npx`, if that suits your workflow better.
+It does the same thing:
+
+```sh
 npx create-clientkit@latest [directory] [options]
 ```
 
+Note that this is about how you _invoke_ the CLI. Which package manager installs
+the generated project's dependencies is a separate choice — detected from your
+environment, or forced with `--pm`.
+
 | Flag                  | Description                               |
 | --------------------- | ----------------------------------------- |
 | `-t, --template <id>` | Template to scaffold from                 |
@@ -115,11 +143,27 @@ One template ships in V1:
 | ---------------- | --------------------------------------- | --------------------- |
 | `astro-tailwind` | Astro 7, Tailwind CSS 4, TypeScript 5.9 | `coming-soon`, `full` |
 
-- **`coming-soon`** — a single polished launch page you can put live today.
-- **`full`** — a small home page with sections, on the same design system.
+- **`coming-soon`** — a single polished launch page you can put live today,
+  with an optional launch date and a progressive-enhancement countdown.
+- **`full`** — a small multi-section home page, on the same design system.
 
 Both include the custom 404, the design system and the full SEO layer.
 
+### URL-less
+
+Not a third mode — a state either mode starts in, and a supported one. When you
+have not decided on a domain, leave the production URL unset and the generated
+site **omits** every absolute tag rather than pointing it at a guess: no
+canonical, no `og:url`, no sitemap, and no `Sitemap:` line in `robots.txt`.
+
+```sh
+npm create clientkit@latest acme-website --yes   # no --url: URL-less
+```
+
+Set `SITE.url` in `src/config/site.config.ts` whenever the domain is known and
+all of it appears on the next build. Nothing needs regenerating, and no
+placeholder domain was ever written to disk.
+
 ## The generated project
 
 ```sh

package/dist/cli.js

@@ -2477,7 +2477,7 @@ var Logger = class {
 };
 
 // src/version.ts
-var CLI_VERSION = true ? "1.0.1" : "0.0.0-dev";
+var CLI_VERSION = true ? "1.0.2" : "0.0.0-dev";
 
 // src/cli.ts
 async function main(argv, options = {}) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-clientkit",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Create the boring foundation of your next client website in seconds.",
   "keywords": [
     "cli",

package/templates/astro-tailwind/base/README.md

@@ -24,7 +24,8 @@ npm run dev
 1. **`src/config/site.config.ts`** - the single source of truth, and the only
    file you need for most client changes:
    - `SITE` - name, description, production URL, locale, author
-   - `NAV` - header links (empty means no menu is rendered at all)
+   - `NAV` - header links (empty means no menu is rendered at all; in
+     coming-soon mode the home page has no header, so they show on the 404 only)
    - `SOCIAL` - social profiles (empty means no links are rendered)
    - `CONTACT` - email, phone, location; each is optional
    - `LAUNCH` - optional launch date and countdown

package/templates/astro-tailwind/base/src/config/site.config.ts

@@ -106,6 +106,12 @@ export const SITE: SiteIdentity = {
 /**
  * Site navigation. Empty by default: the header renders no menu at all rather
  * than inventing links. Add items once real pages or sections exist.
+ *
+ * NAV drives the header, so it shows up only on pages that render one. In
+ * coming-soon mode the home page deliberately has no header - it carries its
+ * own brand lockup instead - so there these links appear on the 404 page only.
+ * Delete `showHeader={false}` from src/pages/index.astro if you want a header
+ * and menu on the launch page too.
  */
 export const NAV: NavItem[] = [];
 

package/templates/astro-tailwind/modes/coming-soon/src/pages/index.astro

@@ -10,7 +10,17 @@ const hasSocial = SOCIAL.some((link) => link.label !== '' && link.href !== '');
 const hasLaunch = LAUNCH.enabled && LAUNCH.date !== '';
 ---
 
-{/* The page carries its own brand lockup, so a header would only repeat it. */}
+{
+  /*
+  No header here: the page carries its own brand lockup below, and repeating it
+  in a bar would say the same thing twice on one screen. A launch page also has
+  nowhere to navigate to yet.
+
+  This is why NAV in src/config/site.config.ts does not show on this page - it
+  drives the header, and there is no header. It still applies to the 404 page.
+  Delete showHeader={false} if you want a header and menu here too.
+*/
+}
 <BaseLayout showHeader={false} measure="narrow">
   <div class="hero">
     <div class="glow" aria-hidden="true"></div>