Overhaul the README: from one sentence to something you can actually use - #5
Merged
Merged
Conversation
Refresh the line-count claim (~2,600 src + ~850 test lines after the recent fixes), document the min/dev branch model, add the CORECODER_TIMEOUT_MS env var, describe the fixed-overhead calibration accurately, and list scripts/ in the layout.
nullcache
force-pushed
the
fix/readme-overhaul
branch
from
August 17, 2026 04:55
cc3b1db to
f21388b
Compare
Drop the npm install command (package is not published), mark the Ollama quick start as needing a dummy key, scope the .env lookup claim to the home directory, soften the design-commentary claim, and reword the branch descriptions (min: kept as small as possible; dev: enhancements no longer bound by the minimal bar).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README was one sentence long, which is rough when the whole pitch of the project is "read the code and learn how an agent actually works." I went through every module and wrote it up properly.
What's in there:
I also re-checked the whole thing against the source afterward and caught a couple of my own mistakes: the API key env precedence was backwards (CORECODER_API_KEY actually wins over OPENAI_API_KEY), and I'd written that Ctrl+C kills running tool processes, which isn't true yet — both fixed.
Left out on purpose: any "features" list that promises stuff the code doesn't do. Happy to add a demo gif or screenshots if you want them.