Skip to content

Commit 707190c

Browse files
authored
Update README.md
1 parent 55fa4ad commit 707190c

1 file changed

Lines changed: 35 additions & 2 deletions

File tree

README.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,10 @@ A high-performance, Dockerized URL Shortener API built with <strong>FastAPI</str
1919
</p>
2020
<p align="center">
2121
<img src="https://img.shields.io/github/license/lyushher/fastapi-url-shortener?color=yellow" />
22+
<img src="https://img.shields.io/github/v/release/lyushher/fastapi-url-shortener?color=success" alt="GitHub Release" />
2223
</p>
2324

25+
2426
---
2527

2628
## 🌐 Project Overview
@@ -63,7 +65,7 @@ This project is built using modern and scalable technologies to ensure high perf
6365

6466
## 🔐 Security & Authentication
6567

66-
> ℹ️ Note: This project does not implement authentication or rate limiting.
68+
> Note: This project does not implement authentication or rate limiting.
6769
If deployed in a public environment, consider adding access control or usage limits to prevent abuse.
6870

6971
---
@@ -111,7 +113,36 @@ This project follows a fully automated CI/CD process using GitHub Actions:
111113
4. **Pull Latest Code**: The latest codebase is pulled from the GitHub repository.
112114
5. **Rebuild Docker Container**: The container is rebuilt to reflect the new changes.
113115
6. **Restart Application**: The old container is gracefully stopped and replaced with the new version.
116+
7. **Version Tagging**: Each stable release is tagged (e.g., `v1.0.0`) and pushed to Docker Hub.
117+
118+
---
119+
120+
## 🐳 Docker Image
121+
122+
This project provides a prebuilt Docker image hosted on [Docker Hub](https://hub.docker.com/repository/docker/firdevsakbayir/urlshortener).
123+
You can pull and run the image directly without cloning the source code.
124+
125+
### 📥 Pull the Image
126+
Pull the latest prebuilt image from Docker Hub.
127+
This eliminates the need to clone or build the project locally.
128+
```bash
129+
docker pull firdevsakbayir/urlshortener:latest
130+
```
131+
132+
### 🚀 Run the Container
133+
Run the pulled Docker image by mapping port `8001` on your machine to port `80` inside the container.
134+
After running, you can access the API at [http://localhost:8001/docs](http://localhost:8001/docs).
135+
```bash
136+
docker run -d -p 8001:80 firdevsakbayir/urlshortener:latest
137+
```
114138

139+
### 📎 Notes
140+
- The image is automatically built and published on Docker Hub.
141+
- Tag latest refers to the most recent stable release.
142+
- Versioned tags (e.g., v1.0.0) are now available for stable releases.
143+
- Suitable for containerized deployments and CI/CD pipelines.
144+
145+
115146
---
116147

117148
## ⚠️ Known Limitations
@@ -128,6 +159,8 @@ Even though the service is production-ready, the current version includes the fo
128159

129160
## 📄 License
130161

131-
This project is licensed under the [MIT License](LICENSE).
162+
This project is open-source and available under the terms of the [MIT License](LICENSE).
163+
164+
132165

133166

0 commit comments

Comments
 (0)