clankie 0.2.1 → 0.2.3

package/README.md

@@ -15,31 +15,40 @@ A minimal AI assistant that lives in Slack. Built on [pi](https://github.com/bad
 
 ### 1. Install Dependencies
 
-Requires [Bun](https://bun.sh):
+**Runtime:** [Node.js](https://nodejs.org) v18+  
+**Build:** [Bun](https://bun.sh) v1.0+ (for bundling and building web-ui)
 
 ```bash
-# macOS/Linux
-curl -fsSL https://bun.sh/install | bash
+# Check Node version
+node --version  # Should be >= v18.0.0
 
-# Verify
+# Install Bun (if not already installed)
+curl -fsSL https://bun.sh/install | bash
 bun --version
 ```
 
-### 2. Clone and Install
+**Don't have Node.js?** Install via [mise](https://mise.jdx.dev) (recommended) or [nvm](https://github.com/nvm-sh/nvm).
+
+### 2. Quick Install via npm
 
 ```bash
-git clone https://github.com/thiagovarela/clankie
-cd clankie
-bun install
+npm install -g clankie
 ```
 
-### 3. Link Globally (Optional)
+This installs clankie globally. Now `clankie` is available from anywhere.
+
+### 3. Or: Install from Source
 
 ```bash
-bun link
+git clone https://github.com/thiagovarela/clankie
+cd clankie
+npm install
+npm link
 ```
 
-Now `clankie` is available from anywhere. If you skip this, use `bun run src/cli.ts` instead of `clankie`.
+Now `clankie` is available from anywhere. If you skip `npm link`, use `bun src/cli.ts` (dev) or `node dist/cli.js` (built) instead of `clankie`.
+
+**Note:** Bun bundles TypeScript code into JavaScript that runs on Node.js v18+.
 
 ## Slack Setup
 
@@ -288,8 +297,15 @@ Logs are stored in `~/.clankie/logs/daemon.log`.
 
 ```bash
 # Run directly with Bun (no build step)
-bun run src/cli.ts chat
-bun run src/cli.ts send "hello"
+bun src/cli.ts chat
+bun src/cli.ts send "hello"
+
+# Or use bun scripts
+bun run dev chat
+bun run dev send "hello"
+
+# Build for production
+bun run build        # Bundles TypeScript → JavaScript for Node.js
 
 # Code quality checks
 bun run check        # Run linter