Repository navigation
docs(readme): refresh header and badges, fix stale content - #36
Merged
Merged
Conversation
Signed-off-by: BryanFRD <bryanferrando59@gmail.com>
BryanFRD
enabled auto-merge (squash)
October 31, 2026 11:19
![ferrfleet-interne[bot]](https://avatars.githubusercontent.com/in/5311663?s=60&v=4){kind=small}
There was a problem hiding this comment.
Approve. Docs-only change, no blocking issues. One optional suggestion.
Suggestions
- Suggestion,
README.md:38: The configuration table (FERRGROWTH_API_URL,FERRGROWTH_API_VERSION, pinned version2026-08-04) duplicates the one inmcp/README.md. The next API version bump has to touch both files, and the root copy is the one likely to be forgotten. The paragraph right after the table already links tomcp/README.md. Either drop the table and keep the link tomcp/README.md#configuration, or keep the duplication on purpose.
Review notes
The claims in the new README match the head commit: ci.yml and LICENSE exist, the env var defaults, Node >=22 / pnpm 12 engines, the pnpm smoke script and the tool coverage agree with mcp/README.md and mcp/package.json.
Formal verification
Nothing to prove. The change is documentation (README.md) and a static image (.github/logo.svg), with no executable code. No properties, harnesses or counterexamples.
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
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.
Standard header: logo next to the name, badges that actually render, links. README checked against the code, stale content fixed. Docs only.