docs: rewrite README in English with badges and API documentation#1
Merged
docs: rewrite README in English with badges and API documentation#1
Conversation
Owner
CFBruna
commented
Dec 3, 2025
CFBruna
commented
- Translate entire README from Portuguese to English
- Add comprehensive badges (Python, Django, DRF, PostgreSQL, Docker, Ruff, Coverage, CI)
- Highlight 96% test coverage achievement
- Document all API endpoints with correct HTTP methods and paths
- Fix authentication endpoints paths (authentication/token/*)
- Correct get-by-plate endpoint method (POST instead of GET)
- Add complete CRUD documentation for vehicle types
- Include API documentation endpoints (Swagger, ReDoc)
- Add project structure section
- Improve setup instructions with environment variables
- Add authentication guide with JWT examples
- Translate entire README from Portuguese to English - Add comprehensive badges (Python, Django, DRF, PostgreSQL, Docker, Ruff, Coverage, CI) - Highlight 96% test coverage achievement - Document all API endpoints with correct HTTP methods and paths - Fix authentication endpoints paths (authentication/token/*) - Correct get-by-plate endpoint method (POST instead of GET) - Add complete CRUD documentation for vehicle types - Include API documentation endpoints (Swagger, ReDoc) - Add project structure section - Improve setup instructions with environment variables - Add authentication guide with JWT examples
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
1 participant
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.