Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: change project name & write a better README #10

Merged
merged 5 commits into from
Jan 27, 2025
Merged

Conversation

hadrien
Copy link
Owner

@hadrien hadrien commented Jan 27, 2025

Problem

  • Project name is too long
  • README is not surfacing the appeal of the project

Solution

  • Use a shorter name: Fastapi-Async-SQLA -> FastSQLA
  • Add a first list of features
  • Write a better example in the readme

Verified

This commit was signed with the committer’s verified signature. The key has expired.
hadrien Hadrien David

Verified

This commit was signed with the committer’s verified signature. The key has expired.
hadrien Hadrien David
Copy link

codecov bot commented Jan 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (264a29e) to head (6f4e3c5).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #10   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines           93        93           
  Branches         6         6           
=========================================
  Hits            93        93           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@hadrien hadrien force-pushed the docs/readme branch 25 times, most recently from 4ad8492 to b7a0ec6 Compare January 27, 2025 18:07
@hadrien hadrien force-pushed the docs/readme branch 5 times, most recently from 7163a10 to 67bb8eb Compare January 27, 2025 18:23
@hadrien hadrien merged commit af90cc5 into main Jan 27, 2025
4 checks passed
@hadrien hadrien deleted the docs/readme branch January 27, 2025 19:13
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.

None yet

1 participant