goshorly/README.md
Phil 21a143f522
All checks were successful
ci/woodpecker/push/0-pre Pipeline was successful
ci/woodpecker/push/10-build-latest Pipeline was successful
ci/woodpecker/pr/0-pre Pipeline was successful
ci/woodpecker/pr/10-build-latest Pipeline was successful
Changed README for more information
2025-04-06 15:54:25 +02:00

48 lines
No EOL
1.2 KiB
Markdown

![Build Status](https://ci.hackmi.ch/api/badges/11/status.svg)
**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 )
### 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.