shadcn-scaffold 1.0.0 → 1.0.2

package/README.md

@@ -1,15 +1,73 @@
-# cli-tool
+# shadcn-scaffold
 
-To install dependencies:
+Scaffold Vite + React + shadcn/ui apps from the terminal.
+
+## Install
+
+Install globally:
+
+```bash
+npm install -g shadcn-scaffold
+```
+
+Or use Bun:
+
+```bash
+bun add -g shadcn-scaffold
+```
+
+Run it without a global install:
+
+```bash
+npx shadcn-scaffold my-app
+bunx shadcn-scaffold my-app
+```
+
+## Usage
+
+Create a new app:
+
+```bash
+scaffold my-app
+```
+
+The CLI will:
+
+- create a Vite React app
+- configure Tailwind CSS
+- initialize shadcn/ui
+- add the `button` component
+- set up a theme provider and theme toggle
+- let you optionally install extra packages
+
+## Development
+
+Install dependencies:
 
 ```bash
 bun install
 ```
 
-To run:
+Run the CLI locally:
 
 ```bash
-bun run index.ts
+bun run dev -- my-app
 ```
 
-This project was created using `bun init` in bun v1.3.10. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
+Build the publishable output:
+
+```bash
+bun run build
+```
+
+## Publish
+
+This package publishes a `scaffold` command, even though the npm package name is `shadcn-scaffold`.
+
+```json
+{
+  "bin": {
+    "scaffold": "./dist/index.js"
+  }
+}
+```

package/dist/create.js

@@ -3,7 +3,7 @@ import { execa } from "execa";
 import chalk from "chalk";
 import fs from "fs";
 import path from "path";
-import { appTsxCode, indexCss, mainTsxCode, modeToggleCode, themeProviderCode, viteConfig, } from "./templates";
+import { appTsxCode, indexCss, mainTsxCode, modeToggleCode, themeProviderCode, viteConfig, } from "./templates.js";
 export async function create(projectName, packages) {
     const spinner = ora("Scaffolding Vite React app...").start();
     try {

package/package.json

@@ -1,6 +1,15 @@
 {
   "name": "shadcn-scaffold",
-  "version": "1.0.0",
+  "version": "1.0.2",
+  "description": "Scaffold Vite + React + shadcn/ui apps from the terminal",
+  "keywords": [
+    "cli",
+    "scaffold",
+    "shadcn",
+    "vite",
+    "react"
+  ],
+  "license": "MIT",
   "bin": {
     "scaffold": "./dist/index.js"
   },