README.md

@@ -1,24 +1,48 @@
-[![status-badge](https://ci.hackmi.ch/api/badges/11/status.svg)](https://ci.hackmi.ch/repos/11)
+![Build Status](https://ci.hackmi.ch/api/badges/11/status.svg)
-# goshorly
-An easy self-hosted Link shortener in Golang with Redis <3
 
----
+**Easy-to-use, self-hosted link shortener built with Golang and Redis.**
 
-Docker Supported:
+Lightweight, fast, and Docker-compatible for seamless deployment. ❤️
-- linux/amd64
-- linux/arm/v6
-- linux/arm64/v8
 
-See docker-compose.yml as example
+### Features
 
----
+Self-hosted: Take control of your link shortening service.
 
-Live-Demo:
+Built with Golang: High performance and reliability.
-- https://2slk.com Hosted by nitmali in Chinese
 
----
+Redis Integration: Efficient data storage.
 
-**WARNING:**
+Docker Support: Multi-platform compatibility ( linux/amd64, linux/arm/v6, linux/arm64/v8 )
-- goshorly is in an early stage, it is not an Final Version! (Pre-Release Status v0.1.X)
 
-If you have an feature request, please do not hesitate to open an issue or merge request.
+
+
+
+
+### Installation
+
+#### Using Docker
+(please refer to the example files!)
+
+``` bash
+git clone https://github.com/yourusername/goshorly.git
+cd goshorly
+docker-compose up -d
+```
+
+To simplify your deployment, we offer the following Docker tags:
+
+- dev: Latest code from the main branch (experimental).
+- latest: Latest stable release (may include breaking changes).
+- Versioned Tags (vX, vX.X, vX.X.X): Specific release versions.
+
+
+### Contributing
+
+We welcome contributions!
+If you have feature requests, bug reports, or improvements, feel free to:
+
+- Open an issue.
+- Fork the repository.
+- Create a new branch (feature/awesome-feature).
+- Submit a pull request with detailed explanations.
+- Submit a review.