From a72240e4f2ab0eb2ed3b8b1cea5064fb0de2b03c Mon Sep 17 00:00:00 2001 From: Phil Date: Sun, 6 Apr 2025 15:54:25 +0200 Subject: [PATCH] Changed README for more information --- README.md | 56 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 40 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 3f35877..47e92d5 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,48 @@ -[![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 +![Build Status](https://ci.hackmi.ch/api/badges/11/status.svg) ---- +**Easy-to-use, self-hosted link shortener built with Golang and Redis.** -Docker Supported: -- linux/amd64 -- linux/arm/v6 -- linux/arm64/v8 +Lightweight, fast, and Docker-compatible for seamless deployment. ❤️ -See docker-compose.yml as example +### Features ---- +Self-hosted: Take control of your link shortening service. -Live-Demo: -- https://2slk.com Hosted by nitmali in Chinese +Built with Golang: High performance and reliability. ---- +Redis Integration: Efficient data storage. -**WARNING:** -- goshorly is in an early stage, it is not an Final Version! (Pre-Release Status v0.1.X) +Docker Support: Multi-platform compatibility ( linux/amd64, linux/arm/v6, linux/arm64/v8 ) -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. \ No newline at end of file