diff --git a/README.md b/README.md index 47e92d5..07823ed 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,23 @@ -![Build Status](https://ci.hackmi.ch/api/badges/11/status.svg) +[![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. ❤️ +--- + ### Features -Self-hosted: Take control of your link shortening service. - -Built with Golang: High performance and reliability. - -Redis Integration: Efficient data storage. - -Docker Support: Multi-platform compatibility ( 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/arm/v6, linux/arm64/v8 ) +--- ### Installation - #### Using Docker (please refer to the example files!) @@ -35,6 +33,13 @@ To simplify your deployment, we offer the following Docker tags: - 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. + +--- ### Contributing