From 38e3f4af4e1a506be071c74831f4b75c716e536c Mon Sep 17 00:00:00 2001
From: YANGCHUNHONG3000 <250981657@qq.com>
Date: Wed, 24 Jun 2026 08:42:54 +0800
Subject: [PATCH] docs: improve README with badges, quick start, and project
 structure

---
 README.md | 77 ++++++++++++++++++++++++++++++++++++++++---------------
 1 file changed, 56 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index 17b868c4..e73e6edd 100644
--- a/README.md
+++ b/README.md
@@ -1,37 +1,72 @@
-# python-flask-docker
-Basic Python Flask app in Docker which prints the hostname and IP of the container
+# 🐳 Python Flask + Docker
+
+A minimal, ready-to-run Python Flask application containerized with Docker. Perfect for learning Docker basics, testing container orchestration, or using as a starter template.
+
+[![Docker Pulls](https://img.shields.io/docker/pulls/lvthillo/python-flask-docker)](https://hub.docker.com/r/lvthillo/python-flask-docker)
+[![License](https://img.shields.io/github/license/lvthillo/python-flask-docker)](LICENSE)
+[![GitHub stars](https://img.shields.io/github/stars/lvthillo/python-flask-docker)](https://github.com/lvthillo/python-flask-docker/stargazers)
+
+## 🎯 What It Does
+
+Launches a Flask web server inside a Docker container. When you visit the page, it displays:
 
-### Build application
-Build the Docker image manually by cloning the Git repo.
 ```
-$ git clone https://github.com/lvthillo/python-flask-docker.git
-$ docker build -t lvthillo/python-flask-docker .
+The hostname of the container is abc123 and its IP is 172.17.0.2.
 ```
 
-### Download precreated image
-You can also just download the existing image from [DockerHub](https://hub.docker.com/r/lvthillo/python-flask-docker/).
-```
+This confirms the container is running and shows key networking info — useful for demos, testing, and learning Docker networking.
+
+## ⚡ Quick Start
+
+### Prerequisites
+- [Docker](https://docs.docker.com/get-docker/) installed
+
+### Option 1: Pull from Docker Hub (fastest)
+```bash
 docker pull lvthillo/python-flask-docker
+docker run -d -p 8080:8080 --name flask-demo lvthillo/python-flask-docker
 ```
+Visit http://localhost:8080
 
-### Run the container
-Create a container from the image.
+### Option 2: Build from source
+```bash
+git clone https://github.com/lvthillo/python-flask-docker.git
+cd python-flask-docker
+docker build -t python-flask-docker .
+docker run -d -p 8080:8080 --name flask-demo python-flask-docker
 ```
-$ docker run --name my-container -d -p 8080:8080 lvthillo/python-flask-docker
+
+## 🔍 Verify It's Running
+```bash
+# Check container IP
+docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' flask-demo
+
+# Check container hostname
+docker inspect -f '{{ .Config.Hostname }}' flask-demo
+
+# View logs
+docker logs flask-demo
 ```
 
-Now visit http://localhost:8080
+## 📁 Project Structure
 ```
- The hostname of the container is 6095273a4e9b and its IP is 172.17.0.2. 
+python-flask-docker/
+├── app.py          # Flask application
+├── Dockerfile       # Docker build instructions
+├── requirements.txt # Python dependencies
+└── README.md
 ```
 
-### Verify the running container
-Verify by checking the container ip and hostname (ID):
-```
-$ docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' my-container
-172.17.0.2
-$ docker inspect -f '{{ .Config.Hostname }}' my-container
-6095273a4e9b
+## 🧹 Stop & Clean Up
+```bash
+docker stop flask-demo
+docker rm flask-demo
 ```
 
+## 🤝 Contributing
+
+Pull requests are welcome! This project is actively maintained. If you have ideas for improvements, feel free to open an issue or submit a PR.
+
+## 📄 License
 
+MIT © [Lorenz Vanthillo](https://github.com/lvthillo)