Skip to content

docs: improve README with badges, quick start, and project structure - #54

Merged
lvthillo merged 2 commits into
lvthillo:masterfrom
YANGCHUNHONG3000:master
Jul 26, 2026
Merged

docs: improve README with badges, quick start, and project structure#54
lvthillo merged 2 commits into
lvthillo:masterfrom
YANGCHUNHONG3000:master

Conversation

@YANGCHUNHONG3000

Copy link
Copy Markdown
Contributor

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:

  • 🎯 A "What It Does" section explaining the project's purpose
  • ⚡ Quick Start with two options (Docker Hub pull + build from source)
  • 🔍 Verify & cleanup commands
  • 📁 Project structure overview
  • 🤝 Contributing section (encourages more contributions)
  • 🛡️ Docker Pulls / License / Stars badges

No code changes — just making the documentation more beginner-friendly. Hope this helps! 🙌

@YANGCHUNHONG3000

Copy link
Copy Markdown
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. 🙌

@lvthillo

Copy link
Copy Markdown
Owner

@YANGCHUNHONG3000

Hey, thanks for your PR. I still have a few remarks:

  • There’s nothing wrong with using an emoji, but personally I find it a bit over the top here.
  • The project structure is not correct; app.py is located in src.
  • I wouldn't use abc123 which is not a valid example of a container name.
  • I'd like to keep the naming as lvthillo/python-flask-docker instead of python-flask-docker.
    _ I would leave out the topic Contributing (this belongs in a contributing.md but this is such a basic example that a lot of PRs wouldn't make a real sense.
  • The license is not correct either. Although an MIT license would make more sense for this repo. I’ll update that myself ASAP.

Thanks!

@YANGCHUNHONG3000

Copy link
Copy Markdown
Contributor Author

Thanks for the review! I have updated the README:

  • Removed emojis
  • Fixed project structure (app.py is now under src/)
  • Changed example container name from abc123 to a real hostname example
  • Removed Contributing section
  • Kept the repo name as lvthillo/python-flask-docker

Let me know if there is anything else to adjust.

@lvthillo
lvthillo merged commit 2698e41 into lvthillo:master Jul 26, 2026
1 check 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.

2 participants