docs: comprehensive README rewrite for GitHub publishing

Browse Source

- Add badges (MIT license, Node.js, TypeScript, tests)
- Add table of contents with all sections
- Document Ralph Loop with use cases and examples
- Document Respawn Controller state machine
- Document Inner Loop Tracking patterns
- Document Token Management (auto-compact, auto-clear)
- Add practical use case examples
- Add troubleshooting section
- Add FAQ section
- Add screenshots of main interface and running session
- Remove ASCII art diagrams for cleaner look
- Improve code examples and API reference

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

...

This commit is contained in:

arkon

2026-01-21 03:13:56 +01:00

co-authored by Claude Opus 4.5

parent 4f11e029e5

commit 70d87220aa

3 changed files with 539 additions and 417 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

README.md

+539 -417

File diff suppressed because it is too large Load Diff

docs/screenshots/main-interface.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 27 KiB

docs/screenshots/session-running.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 74 KiB