docs: improve README with badges, quick start, and project structure - #54
Merged
Conversation
Contributor
Author
|
Hey! 👋 Just a friendly check-in — all checks are passing and there's no merge conflict, so this should be straightforward to merge. Is there anything I can help adjust? Happy to make changes if needed. 🙌 |
Owner
|
Hey, thanks for your PR. I still have a few remarks:
Thanks! |
Contributor
Author
|
Thanks for the review! I have updated the README:
Let me know if there is anything else to adjust. |
lvthillo
approved these changes
Jul 26, 2026
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
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.
Hey! 👋
I came across your project and noticed the README was very minimal — just a few commands without much context. Since this is a great starter template for Flask + Docker beginners, I thought a clearer README would help more people discover and use it.
Here's what I added:
No code changes — just making the documentation more beginner-friendly. Hope this helps! 🙌