Skip to content

docs: rewrite README to be more approachable and discoverable - #11

Merged
avivklas merged 1 commit into
mainfrom
cursor/readme-discoverability
Sep 30, 2026
Merged

avivklas merged 1 commit into
mainfrom
cursor/readme-discoverability

Conversation

@avivklas

Copy link
Copy Markdown
Contributor

Summary

  • Lead with the problem users actually search for: the Docker Hub toomanyrequests rate-limit error, followed by a short before/after example.
  • Add badges, a table of contents, a numbered quick start (install → run → use), a comparison table against daemon.json registry-mirrors and manual rewriting, an FAQ, and a Contributing section.
  • Move deep reference material (architecture diagrams, intercepted endpoints, context watching, crash recovery) under "How it works" further down. No content was dropped.

Fixes

  • GitHub Action examples used fender-proxy/fender@v1, which doesn't exist as a tag; they now use @v0.3.2.
  • Install section claimed "Requires Go 1.21+" while go.mod requires 1.26.6; it now points to go.mod and leads with prebuilt release binaries.

Made with Cursor

Co-authored-by: Cursor <cursoragent@cursor.com>
@avivklas
avivklas marked this pull request as ready for review September 30, 2026 11:15
@avivklas
avivklas merged commit 31bad60 into main Sep 30, 2026
10 checks passed
@avivklas
avivklas deleted the cursor/readme-discoverability branch September 30, 2026 11:23
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