From 13a20dd1a3593e314ae02c1e562aa12fae9704fa Mon Sep 17 00:00:00 2001
From: Phil <phil@hackmi.ch>
Date: Mon, 7 Apr 2025 17:42:17 +0000
Subject: [PATCH] Cleaned README and refresh information (#12)

Reviewed-on: https://git.hackmi.ch/Phil/goshorly/pulls/12
---
 README.md | 53 +++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 41 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 3f35877..cd7a912 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,53 @@
 [![status-badge](https://ci.hackmi.ch/api/badges/11/status.svg)](https://ci.hackmi.ch/repos/11)
-# goshorly
-An easy self-hosted Link shortener in Golang with Redis <3
+
+# Goshorly
+**Easy-to-use, self-hosted link shortener built with Golang and Redis.**
+
+Lightweight, fast, and Docker-compatible for seamless deployment. ❤️
 
 ---
 
-Docker Supported:
-- linux/amd64
-- linux/arm/v6
-- linux/arm64/v8
+### Features
 
-See docker-compose.yml as example
+- Self-hosted: Take control of your link shortening service.
+- Built with Golang: High performance and reliability.
+- Redis Integration: Efficient data storage.
+- Easy Deployment: Docker, Binary, Build it yourself
+- Docker Support: ( linux/amd64, linux/arm64 )
 
 ---
 
-Live-Demo:
-- https://2slk.com Hosted by nitmali in Chinese
+### 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.
+
+#### Using Binary
+1. Download the latest binary from the releases.
+2. Create an .env file (or use the .env.example) 
+and change the values for your environment.
+3. Run the binary the terminal.
 
 ---
 
-**WARNING:**
-- goshorly is in an early stage, it is not an Final Version! (Pre-Release Status v0.1.X)
+### Contributing
 
-If you have an feature request, please do not hesitate to open an issue or merge request.
+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.
\ No newline at end of file