Skip to content

docs(readme): refresh header and badges, fix stale content - #21

Merged
BryanFRD merged 1 commit into
mainfrom
docs/readme-refresh
Oct 31, 2026
Merged

BryanFRD merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@BryanFRD

Copy link
Copy Markdown
Contributor

Standard header: logo next to the name, badges that actually render, links. README checked against the code, stale content fixed. Docs only.

Signed-off-by: BryanFRD <bryanferrando59@gmail.com>

@ferrfleet-interne ferrfleet-interne Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approve. Docs-only change with nothing blocking: one suggestion, no counterexamples.

Suggestions

  • Suggestion, README.md:41: the configuration table duplicates mcp/README.md. The env var table and install snippet are copied from mcp/README.md, which stays the canonical reference. When a variable or default changes (FERRFLEET_API_VERSION, for example), one of the two copies will go stale. Keep only the install snippet at the root and point to mcp/README.md#configuration for the variables, or add a note that mcp/README.md is authoritative.

Review notes

The badges, links, env var defaults, Node and pnpm versions and scripts all match the repo (ci.yml, LICENSE, mcp/package.json, mcp/README.md).

Formal verification

Nothing to prove. The PR changes README.md and .github/logo.svg, neither of which contains executable code. No properties were checked and no harnesses were written.

@BryanFRD
BryanFRD merged commit ef49215 into main Oct 31, 2026
16 checks passed
@BryanFRD
BryanFRD deleted the docs/readme-refresh branch October 31, 2026 11:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant