From 88fe746c3f3d503a91af527306bd8d7f0a5fbae5 Mon Sep 17 00:00:00 2001 From: codewithwan Date: Fri, 17 Jul 2026 00:24:42 +0700 Subject: [PATCH] docs: one product, said the same way everywhere MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The repo's front door said 'walks your GitHub contribution year'. Six other shopfronts still said 'a personality layer any CLI can embed' — crates.io, npm, PyPI, and a roadmap whose destination was the embed API. A name change that stops at the README isn't a name change, it's a contradiction someone finds later. awan-cli's description was also wrong on the facts: it listed 'idle', which is a default *event* for react and not a command, and omitted busy, sing and react, which are. Fixed here; crates.io carries it at the next release. The roadmap now says which thing is the pitch and admits the rest is still true. The terminal companion and the embed API both work and both stay — they just aren't the sign above the door. A character card people want beats a library nobody asked for, and pretending otherwise is what kept the front page explaining instead of showing. --- README.md | 17 +++++++++++------ crates/awan-cli/Cargo.toml | 2 +- crates/awan-core/Cargo.toml | 2 +- crates/awan/Cargo.toml | 2 +- packages/npm/package.json | 2 +- packages/pypi/pyproject.toml | 2 +- 6 files changed, 16 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 15161c2..5117905 100644 --- a/README.md +++ b/README.md @@ -215,12 +215,17 @@ library — no Rust, no rebuild of the engine. ## Roadmap -- **Shipping** — seam-free rendering, ambient `watch` companion, cross-language - event protocol with Node/Python/Go/shell clients ([docs](docs/INTEGRATE.md)) -- **v0.1** — prebuilt binaries on every release, polished `awan` binary -- **v0.2** — in-process embed API for Rust CLI authors (`wait` / `ask` / `react`) -- **Later** — more characters and skits, graphics-protocol backends, - community roster +The banner is the product; everything else is how it's made. + +- **Shipping** — profile banners with live numbers, the contribution year, a + browser editor with a character studio, and a reusable workflow you call + rather than copy +- **Next** — more beats worth watching, and somewhere to show the characters + people draw +- **Also true** — he's a terminal companion (`watch`, `busy`, `statusline`) and + a character engine any CLI can embed. Both work today. Neither is the pitch, + and that's a decision, not an oversight: a character card people want beats a + library nobody asked for. ## Promises diff --git a/crates/awan-cli/Cargo.toml b/crates/awan-cli/Cargo.toml index e4c2866..0d2cf07 100644 --- a/crates/awan-cli/Cargo.toml +++ b/crates/awan-cli/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "awan-cli" -description = "The awan binary: demo, watch, idle, statusline" +description = "The awan command — the pixel character from your profile README, running in your terminal" version.workspace = true edition.workspace = true rust-version.workspace = true diff --git a/crates/awan-core/Cargo.toml b/crates/awan-core/Cargo.toml index 09180be..0acc12a 100644 --- a/crates/awan-core/Cargo.toml +++ b/crates/awan-core/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "awan-core" -description = "Scene engine, face system, and character spec for awan — a tiny living character for your terminal" +description = "The engine behind awan: deterministic pixel frames from (tick, character), with characters as TOML" version.workspace = true edition.workspace = true rust-version.workspace = true diff --git a/crates/awan/Cargo.toml b/crates/awan/Cargo.toml index 1393758..81d665c 100644 --- a/crates/awan/Cargo.toml +++ b/crates/awan/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "awan" -description = "A tiny living character for your terminal — and a personality layer any CLI can embed (wait, ask, react)" +description = "Embed awan in your own Rust CLI: wait, ask, react" version.workspace = true edition.workspace = true rust-version.workspace = true diff --git a/packages/npm/package.json b/packages/npm/package.json index 2f1449a..6334ea4 100644 --- a/packages/npm/package.json +++ b/packages/npm/package.json @@ -5,7 +5,7 @@ "access": "public" }, "binaryVersion": "0.0.5", - "description": "A tiny living character for your terminal — a personality layer any CLI can embed.", + "description": "A tiny pixel character that walks your GitHub contribution year — and lives in your terminal.", "keywords": [ "cli", "terminal", diff --git a/packages/pypi/pyproject.toml b/packages/pypi/pyproject.toml index 0f65c6e..02e9f0f 100644 --- a/packages/pypi/pyproject.toml +++ b/packages/pypi/pyproject.toml @@ -5,7 +5,7 @@ build-backend = "hatchling.build" [project] name = "awan-cli" version = "0.0.5" -description = "A tiny living character for your terminal — a personality layer any CLI can embed." +description = "A tiny pixel character that walks your GitHub contribution year — and lives in your terminal." readme = "README.md" requires-python = ">=3.8" authors = [{ name = "codewithwan" }]