init: vibed

1 files changed, 46 insertions, 0 deletions

diff --git a/web/README.md b/web/README.md
new file mode 100644
index 0000000..50e8cef
--- /dev/null
+++ b/web/README.md
@@ -0,0 +1,46 @@
+# ugi.gumx.cc
+
+Web-based UGI (Unified Geek Identifier) encoder, decoder, and format converter.
+
+## What is this?
+
+A self-contained HTML tool for working with UGI strings — the modernized Geek Code. It provides three functions:
+
+- **Encoder** — form-based interface to build a UGI string by selecting fields, sub-IDs, and ratings
+- **Decoder** — paste a UGI string (URI or block format) and see a human-readable breakdown
+- **Converter** — convert between URI format (`ugi:0@handle:...`) and block format
+
+The tool is a single HTML file with no external dependencies. The full UGI registry is embedded inline.
+
+## Usage
+
+Open `index.html` in any browser. No server required.
+
+Supports `prefers-color-scheme` for automatic dark mode.
+
+## Regenerating
+
+The generator script takes the registry JSON path and output file path as arguments:
+
+```bash
+python scripts/gen_tool.py /path/to/ugi_registry_v0.json index.html
+```
+
+### Requirements
+
+- Python 3.8+
+- No external dependencies
+
+## Project structure
+
+```
+ugi.gumx.cc/
+├── index.html       # generated tool (deploy this)
+├── scripts/
+│   └── gen_tool.py  # HTML tool generator
+└── README.md
+```
+
+## License
+
+MIT