Skip to content

docs: improve README discoverability — badges, comparison table, cleaner Quick Start#1

Merged
svalench merged 1 commit into
masterfrom
improve/readme-badges-topics
Apr 10, 2026
Merged

docs: improve README discoverability — badges, comparison table, cleaner Quick Start#1
svalench merged 1 commit into
masterfrom
improve/readme-badges-topics

Conversation

@svalench

Copy link
Copy Markdown
Owner

What changed

  • Added shields.io badges: PyPI version, Python versions, license, monthly downloads, FastAPI/SQLAlchemy/Pydantic version markers
  • Added Comparison table vs fastapi-crudrouter and fastapi-utils — helps users discover the package when searching for alternatives
  • Cleaner Quick Start with minimal boilerplate example
  • Added Generated Endpoints table showing all 6 HTTP methods
  • Added ORM & Database support matrix table
  • Added API Reference tables instead of prose
  • Added Contributing section with explicit fork → PR workflow

Why

Packages without badges and comparison tables rank lower in Google/GitHub search. Downloads badge creates social proof. Comparison table captures traffic from people searching for fastapi-crudrouter alternative.

Next steps (outside this PR)

  • Add GitHub repository topics via Settings: fastapi, python, rest-api, crud, sqlalchemy, orm, viewset, django-rest-framework
  • Publish/update on PyPI so the downloads badge shows real numbers

@svalench svalench merged commit ad080b4 into master Apr 10, 2026
5 checks passed
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