From 1ba58c639234d2182ea4e154a6062e7a6e9b8797 Mon Sep 17 00:00:00 2001 From: codewithwan Date: Thu, 16 Jul 2026 22:13:02 +0700 Subject: [PATCH] docs: point at the editor, which nothing linked to MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The page has been live at codewithwan.github.io/awan since it merged and not one line in the repo mentioned it. A tool nobody can find is a tool that doesn't exist, and the README was still opening the profile section with 'cp -r profile/sample/' — the hard way, presented as the only way. Badge at the top, because that's where people look first, and the section now leads with the editor and keeps the file route for anyone who prefers it. Left the heritage link alone. idcloud.app 404s on every variant, but the domain answers — that's a server saying no, not a domain that's gone, and where IDCloud lives now isn't mine to guess at. --- README.md | 22 ++++++++++++++++++---- profile/README.md | 7 ++++++- 2 files changed, 24 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 31e5f5a..377f9db 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [![CI](https://github.com/codewithwan/awan/actions/workflows/ci.yml/badge.svg)](https://github.com/codewithwan/awan/actions/workflows/ci.yml) [![License: MIT OR Apache-2.0](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue.svg)](#license) +[![Build your banner](https://img.shields.io/badge/build%20your%20banner-codewithwan.github.io%2Fawan-39d353.svg)](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. + +

+ → open the editor +

+ +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