CHANGELOG.md

@@ -19,10 +19,6 @@
 
 - Configure Renovate [[#1](https://git.hackmi.ch/Phil/goshorly/pulls/1)]
 
-### 📚 Documentation
-
-- Cleaned README and refresh information [[#12](https://git.hackmi.ch/Phil/goshorly/pulls/12)]
-
 ### 📦️ Dependency
 
 - Update dependency go to v1.24.2 [[#8](https://git.hackmi.ch/Phil/goshorly/pulls/8)]

README.md

@@ -1,53 +1,24 @@
 [![status-badge](https://ci.hackmi.ch/api/badges/11/status.svg)](https://ci.hackmi.ch/repos/11)
-
-# Goshorly
-**Easy-to-use, self-hosted link shortener built with Golang and Redis.**
-
-Lightweight, fast, and Docker-compatible for seamless deployment. ❤️
+# goshorly
+An easy self-hosted Link shortener in Golang with Redis <3
 
 ---
 
-### Features
+Docker Supported:
+- linux/amd64
+- linux/arm/v6
+- linux/arm64/v8
 
-- 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 )
+See docker-compose.yml as example
 
 ---
 
-### 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.
+Live-Demo:
+- https://2slk.com Hosted by nitmali in Chinese
 
 ---
 
-### Contributing
+**WARNING:**
+- goshorly is in an early stage, it is not an Final Version! (Pre-Release Status v0.1.X)
 
-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.
+If you have an feature request, please do not hesitate to open an issue or merge request.