kanna-code 0.1.3 → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jake Mor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,6 +1,28 @@
-# Kanna
+<p align="center">
+  <img src="assets/icon.png" alt="Kanna" width="80" />
+</p>
 
-A web-first chat UI for using Claude Code in style. Remote access coming soon.
+<h1 align="center">Kanna</h1>
+
+<p align="center">
+  <strong>A beautiful web UI for Claude Code.</strong>
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/kanna-code"><img src="https://img.shields.io/npm/v/kanna-code.svg?style=flat&colorA=18181b&colorB=f472b6" alt="npm version" /></a>
+</p>
+
+<br />
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="assets/screenshot.png" />
+    <source media="(prefers-color-scheme: light)" srcset="assets/screenshot-light.png" />
+    <img src="assets/screenshot.png" alt="Kanna screenshot" width="800" />
+  </picture>
+</p>
+
+<br />
 
 ## Quickstart
 
@@ -8,15 +30,17 @@ A web-first chat UI for using Claude Code in style. Remote access coming soon.
 bun install -g kanna-code
 ```
 
-Then run from anywhere:
+Then run from any project directory:
 
 ```bash
 kanna
 ```
 
+That's it. Kanna opens in your browser at [`localhost:3210`](http://localhost:3210).
+
 ## Features
 
-- **Project-first sidebar** — chats grouped under projects, with status indicators (idle, running, waiting, failed)
+- **Project-first sidebar** — chats grouped under projects, with live status indicators (idle, running, waiting, failed)
 - **Local project discovery** — auto-discovers projects from `~/.claude/projects`
 - **Rich transcript rendering** — user messages, assistant responses, collapsible tool call groups, plan mode dialogs, and interactive prompts
 - **Plan mode** — review and approve agent plans before execution
@@ -45,33 +69,32 @@ Local File System (~/.kanna/data/, project dirs)
 
 ## Requirements
 
-- [Bun](https://bun.sh)
-- A working Claude Agent SDK environment
+- [Bun](https://bun.sh) v1.0+
+- A working [Claude Code](https://docs.anthropic.com/en/docs/claude-code) environment
 
 ## Install
 
-```bash
-bun install
-```
-
-## Run
+Install globally via bun:
 
 ```bash
-bun run build
-bun run start
+bun install -g kanna-code
 ```
 
-Or use the CLI directly:
+Or clone and build from source:
 
 ```bash
-kanna
+git clone https://github.com/jakemor/kanna.git
+cd kanna
+bun install
+bun run build
 ```
 
-Flags:
+## Usage
 
 ```bash
-bun run start -- --no-open
-bun run start -- --port 4000
+kanna                  # start with defaults
+kanna --port 4000      # custom port
+kanna --no-open        # don't open browser
 ```
 
 Default URL: `http://localhost:3210`
@@ -126,7 +149,7 @@ src/
     └── branding.ts  App name, data directory paths
 ```
 
-## Data
+## Data Storage
 
 All state is stored locally at `~/.kanna/data/`:
 
@@ -139,3 +162,7 @@ All state is stored locally at `~/.kanna/data/`:
 | `snapshot.json`  | Compacted state snapshot for fast startup |
 
 Event logs are append-only JSONL. On startup, Kanna replays the log tail after the last snapshot, then compacts if the logs exceed 2 MB.
+
+## License
+
+[MIT](LICENSE)