Skip to content

Commit 60a5fe5

Browse files
committed
docs: rewrite README around agent performance
Cherry-picked from development (8f20e71). New tagline, problem/solution reframed around agent behavior, Why It's Genius leads with performance.
1 parent cbdb918 commit 60a5fe5

File tree

1 file changed

+41
-31
lines changed

1 file changed

+41
-31
lines changed

README.md

Lines changed: 41 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Log File Genius
22

3-
**Stop the context rot. Give your AI a genius-level memory.**
3+
**Make your AI agents rip. Not guess, not loop, not forget — rip.**
44

5-
> A token-efficient documentation system that reduces AI context bloat by 93% while improving project memory.
5+
> Five markdown files + AI rules that give any agent (or subagent) instant, complete project context in under 5% of its context window.
66
77
[![GitHub stars](https://img.shields.io/github/stars/clark-mackey/log-file-genius?style=social)](https://github.com/clark-mackey/log-file-genius/stargazers)
88
[![Use this template](https://img.shields.io/badge/use%20this-template-blue)](https://github.com/clark-mackey/log-file-genius/generate)
@@ -12,64 +12,74 @@
1212

1313
---
1414

15-
## 😫 The Problem: Your AI Has a Terrible Memory
15+
## 😫 The Problem: Your AI Agent Is Working Blind
1616

17-
Traditional project documentation becomes a bloated mess over time. Your AI coding assistant spends half its context window just trying to remember what happened last week.
17+
Your agent doesn't know what happened yesterday. It doesn't know why you chose Postgres over Mongo. It doesn't know its teammate just refactored the auth module. So it guesses, goes in circles, and makes decisions you already made — badly.
1818

19-
**Before Log File Genius:**
20-
- 📊 **90,000-110,000 tokens** of verbose logs.
21-
- 🤖 **45-55% of your AI's context window** wasted on history.
22-
-**Result:** The AI lacks context, makes uninformed decisions, and repeats past mistakes.
19+
**Without Log File Genius:**
20+
- 🔄 **Agents repeat past mistakes** because there's no structured record of what failed and why
21+
- 🧠 **Context lost between sessions** — every new chat starts from scratch
22+
- 🤖 **Subagents start from zero** — they have no idea what the lead agent decided
23+
- 📊 **90,000+ tokens** of bloated docs eating your context window, and the AI *still* doesn't know what's going on
2324

24-
It's like trying to have a conversation with someone who has amnesia. Every. Single. Day.
25+
It's like hiring a brilliant contractor who shows up every morning with amnesia. Every. Single. Day.
2526

26-
Or maybe you are new here and vibe coding your first projects.
27+
Or maybe you're vibe coding your first projects and wondering why the AI keeps going in circles.
2728

28-
**Vibe Coding Before Log File Genius:**
29-
- 📊 **50,000-70,000 tokens** of retrying work-arounds and responding to your questions about how code works.
30-
- 🤖 **45-55% of your AI's context window** wasted on hand holding and ineffective loops through code.
31-
-**Result:** The AI has the wrong context, makes bad decisions, and hallucinates.
29+
**Vibe Coding Without Log File Genius:**
30+
- 🔄 **Endless loops** — the AI retries the same broken approach because it has no memory of what already failed
31+
- 🤖 **Half your context window** wasted on hand-holding and ineffective back-and-forth
32+
-**Result:** The AI hallucinates, makes bad decisions, and you spend more time fixing its work than writing code
3233

33-
## 💡 The Solution: A Genius-Level Memory
34+
## 💡 The Solution: A Shared Brain for Every Agent
3435

35-
Log File Genius is a five-document system that gives your AI a an improved long-term memory while consuming less than **5%** of its context window.
36+
Log File Genius is five markdown files and a set of AI rules. Any agent — lead, subagent, teammate, or a fresh session — reads them and instantly knows: what are we building, what changed, why we decided that, what's happening right now, and what rules we follow.
37+
38+
The AI maintains the files itself. You don't write documentation — the agent does, as part of its workflow.
3639

3740
**After Log File Genius:**
38-
- 📊 **~7,000-10,000 tokens** for complete project history.
39-
- 🤖 **93% reduction** in context bloat.
40-
-**Result:** The AI has near-instant access to all decisions, changes, and narratives, leading to smarter, faster, and more accurate coding.
41+
-**Agents make informed decisions** from the first message — no ramp-up, no guessing
42+
- 🔄 **Session continuity** — handoff protocol means zero context lost between sessions
43+
- 🤖 **Subagents spin up dangerous** — full project context in under 500ms
44+
- 📊 **Up to 93% token reduction** — complete project history in ~7,000-10,000 tokens instead of 90,000+
4145

4246
| Document | The Vibe | Purpose | Token Budget |
4347
|---|---|---|---|
4448
| **PRD** | The Dream ✨ | What we're building and why | ~5k tokens |
45-
| **CHANGELOG** | The Facts 📊 | What changed (files, versions, facts) | ~2k tokens |
46-
| **DEVLOG** | The Story ✍️ | *Why* it changed (the narrative, the reasoning) | ~3k tokens |
49+
| **CHANGELOG** | The Facts 📊 | What changed (files, versions, facts) | <10k tokens |
50+
| **DEVLOG** | The Story ✍️ | *Why* it changed (the narrative, the reasoning) | <15k tokens |
4751
| **ADRs** | The Rules 🏛️ | How we made significant decisions | On-demand |
48-
| **STATE** | The Current State | What agent on what task? | <500 tokens |
52+
| **STATE** | The Now 📍 | What agent is on what task, right now? | <500 tokens |
4953

5054
[Dive into the full methodology →](product/docs/log_file_how_to.md)
5155

5256
---
5357

5458
## 🧠 Why It's Genius
5559

56-
This isn't just another documentation template. It's a complete system designed for AI-first development.
60+
This isn't just documentation. It's an operating system for AI agent performance.
61+
62+
- **🚀 Agents That Actually Perform:** Your agent reads 5 files and knows everything — what we're building, what changed, why, what's happening now, and what rules to follow. No ramp-up. No guessing. Just execution.
63+
64+
- **🔄 Zero Context Loss Between Sessions:** The handoff protocol means a new session picks up exactly where the last one left off. No more "let me re-read the codebase to understand what's going on."
65+
66+
- **🤖 Multi-Agent & Subagent Ready:** Spin up a subagent and it has full project context in seconds. `STATE.md` prevents collisions. The handoff protocol prevents duplicated work. Agent teams that actually coordinate.
5767

58-
- **93% Token Reduction:** Keep your context window free for what matters: the code you're writing *right now*. Sheds old context like a snake sheds its skin.
68+
- **🧠 Self-Regulating:** Agents manage their own token budgets, estimate entry sizes, and archive proactively. No babysitting. No external tools. The AI maintains the files as part of its workflow — you don't write documentation, the agent does.
5969

60-
- **Near Perfect Project Memory:** The five-document system separates facts from narrative, giving your AI a complete, holistic understanding of the project's history and goals.
70+
- **🚨 Learns From Failures:** The `🚨 INCIDENT` format in DEVLOG means agents document what broke, why, and how to prevent it. Next time a similar problem comes up, the agent already knows the answer.
6171

62-
- **⚡ Zero-Search Navigation:** With bidirectional frontmatter linking, your AI never wastes tokens searching for files. It instantly knows where to find related documents.
72+
- **⚡ Zero-Search Navigation:** Bidirectional frontmatter linking means your AI never wastes tokens searching for files. Every document points to its related documents. One hop to anything.
6373

64-
- **🤖 Multi-Agent Ready:** The included `STATE.md` file and handoff protocol provide a lightweight coordination layer, preventing agent collisions and duplicated work in complex, multi-agent environments.
74+
- **📊 Up to 93% Token Reduction:** Sheds old context like a snake sheds its skin. Complete project history in <5% of the context window, leaving the rest for what matters: the code you're writing *right now*.
6575

66-
- **Scalable by Design:** The built-in archiving strategy keeps your active logs lean and fast, even on multi-year projects.
76+
- **🔒 Safety Built In:** Secret detection, log validation, and pre-commit hooks catch problems before they hit the repo. Your agent won't accidentally leak API keys into a DEVLOG entry.
6777

68-
- **Tool Agnostic:** Works seamlessly with Claude, Cursor, GitHub Copilot, Augment, and any other AI coding assistant. Your toaster will probably be running it soon.
78+
- **🔧 Tool Agnostic:** Works with Claude, Cursor, GitHub Copilot, Augment, and any other AI coding assistant. Your toaster will probably be running it soon.
6979

7080
---
7181

72-
## Repository Structure
82+
## 📁 Repository Structure
7383

7484
This repository uses a two-branch strategy: `main` contains only the `product/` directory for distribution, while `development` contains both `product/` and `project/` directories for development work.
7585

@@ -107,7 +117,7 @@ The installer will:
107117
- ✅ Configure everything for immediate use
108118

109119
**What gets installed:**
110-
- `logs/` - All your log files (CHANGELOG, DEVLOG, STATE, ADRs, incidents)
120+
- `logs/` - All your log files (CHANGELOG, DEVLOG, STATE, ADRs)
111121
- `.augment/` or `.claude/` - AI assistant rules
112122
- `.logfile-config.yml` - Profile configuration
113123

0 commit comments

Comments
 (0)