@jsnchn/buntastic 0.0.2 → 0.0.4

package/README.md

@@ -11,16 +11,28 @@ A simple static site generator built with Bun.
 
 ## Installation
 
-### As a CLI tool (recommended)
+### Standalone binary (recommended - no dependencies required)
+
+Download the latest release for your platform from [GitHub Releases](https://github.com/jsnchn/buntastic/releases):
 
 ```bash
-# Install Bun (if needed)
-curl -fsSL https://bun.sh/install | bash
+# Linux/macOS
+curl -fsSL https://github.com/jsnchn/buntastic/releases/latest/download/buntastic -o buntastic
+chmod +x buntastic
+
+# Windows (PowerShell)
+iwr https://github.com/jsnchn/buntastic/releases/latest/download/buntastic.exe -o buntastic.exe
+```
+
+Then run `./buntastic` (or `buntastic.exe` on Windows).
 
-# Install buntastic globally
-bun install -g buntastic
+### With Bun or Node
 
-# Or use npx without installing
+```bash
+# With bun
+bunx buntastic build
+
+# With npx (Node.js)
 npx buntastic build
 ```
 
@@ -31,8 +43,11 @@ npx buntastic build
 git clone https://github.com/jsnchn/buntastic.git
 cd buntastic
 
+# Build the binary
+bun run build:binary
+
 # Start the dev server
-bun run dev
+./buntastic dev
 ```
 
 Visit `http://localhost:3000` to see your site.
@@ -61,8 +76,25 @@ buntastic/
 | `buntastic build --drafts` | Build with drafts included |
 | `buntastic dev` | Watch mode + dev server |
 | `buntastic preview` | Serve the built `dist/` folder |
+| `buntastic init` | Initialize a new project (creates files) |
 
-Or with bun run (if using from source):
+## File Structure Safety
+
+Buntastic commands interact with your project in different ways:
+
+| Command | Modifies Source Files? |
+|---------|----------------------|
+| `build` | No - only creates/updates `dist/` |
+| `build --drafts` | No - only creates/updates `dist/` |
+| `dev` | No - only creates/updates `dist/` |
+| `preview` | No - only reads `dist/` |
+| `init` | **Yes** - creates `content/`, `src/layouts/`, `public/`, and `package.json` |
+
+**Safe commands** (`build`, `dev`, `preview`) only read from your source files and output to the `dist/` folder. They will not modify your `content/`, `src/layouts/`, `public/`, or `package.json`.
+
+**Destructive command** (`init`) creates new files and **will overwrite** an existing `package.json`. Use this only on new projects or when you want to start fresh.
+
+Or when using from source with bun:
 
 | Command | Description |
 |---------|-------------|
@@ -70,6 +102,9 @@ Or with bun run (if using from source):
 | `bun run build:drafts` | Build with drafts included |
 | `bun run dev` | Watch mode + dev server |
 | `bun run preview` | Serve the built `dist/` folder |
+| `bun run init` | Initialize a new project (creates files) |
+
+Note: When using from source, `bun run dev` internally runs `./buntastic dev` after building.
 
 ## Writing Content
 
@@ -212,11 +247,13 @@ Drafts are included when running `bun run build:drafts`.
 
 ## Tech Stack
 
-- [Bun](https://bun.sh) - JavaScript runtime
+- [Bun](https://bun.sh) - Runtime used to build the binary
 - Bun.markdown - Built-in GFM markdown parser
 - Bun.serve - HTTP server
 - Bun.watch - File watching
 
+The published binary has no runtime dependencies - users don't need Bun or Node.js installed.
+
 ## License
 
 MIT

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "@jsnchn/buntastic",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "A simple static site generator built with Bun",
   "type": "module",
   "bin": {
     "buntastic": "src/index.ts"
   },
   "scripts": {
+    "build:binary": "bun build --compile src/index.ts --outfile buntastic",
+    "prepublish": "bun build --compile src/index.ts --outfile buntastic",
     "build": "buntastic build",
     "build:drafts": "buntastic build --drafts",
     "dev": "buntastic dev",

package/src/index.ts

@@ -1,4 +1,3 @@
-#!/usr/bin/env bun
 import { mkdir, writeFile, readFile, copyFile, exists } from "fs/promises";
 import { join, relative, dirname, extname } from "path";
 import { Glob } from "bun";