diff --git a/README.md b/README.md index 31e5f5a..377f9db 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [](https://github.com/codewithwan/awan/actions/workflows/ci.yml) [](#license) +[](https://codewithwan.github.io/awan/) > A tiny living character for your terminal — and a **personality layer** any > CLI can embed: `wait`, `ask`, `react`. @@ -144,16 +145,29 @@ included.
-Copy the ready-made setup and edit one file: +### Build one without writing any JSON + +**[codewithwan.github.io/awan](https://codewithwan.github.io/awan/)** — arrange +the beats, watch it play, take the three files. The preview is the engine itself +compiled to wasm, so the frames you're looking at are the frames CI will draw. + +Nothing is stored and there's no server behind it: your config lives in your +repo, and the workflow runs there. That's also why the page can't break your +banner. + + + +Prefer files? Copy the ready-made setup and edit one: ```sh cp -r profile/sample/. my-profile/ # awan.json + a GitHub Action + a profile README cargo run -p awan-profile -- whoami --config my-profile/awan.json ``` -Full walkthrough, the `awan.json` format, and how to auto-regenerate it on every -push: **[`profile/`](profile)**. Built as a separate, opt-in crate, so the core -`awan` stays untouched. +Full walkthrough and the `awan.json` format: **[`profile/`](profile)**. Built as +a separate, opt-in crate, so the core `awan` stays untouched. ## Characters diff --git a/profile/README.md b/profile/README.md index 6f91739..2d0e068 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,4 +1,9 @@ -# awan profile generator +# awan profile + +> **[Build one in the browser →](https://codewithwan.github.io/awan/)** Arrange +> the beats, watch it play, download the folder. The preview runs the real +> engine, so it draws the frames CI draws. Everything below is the same thing, +> by hand. generator Turn awan into a **seam-free looping banner for your GitHub profile** — he walks in and tells your story, then loops (~60s). A separate, opt-in tool: it never