Cleaned README and refresh information #12
1 changed files with 17 additions and 12 deletions
29
README.md
29
README.md
|
@ -1,25 +1,23 @@
|
||||||

|
[](https://ci.hackmi.ch/repos/11)
|
||||||
|
|
||||||
|
# Goshorly
|
||||||
**Easy-to-use, self-hosted link shortener built with Golang and Redis.**
|
**Easy-to-use, self-hosted link shortener built with Golang and Redis.**
|
||||||
|
|
||||||
Lightweight, fast, and Docker-compatible for seamless deployment. ❤️
|
Lightweight, fast, and Docker-compatible for seamless deployment. ❤️
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
|
|
||||||
Self-hosted: Take control of your link shortening service.
|
- Self-hosted: Take control of your link shortening service.
|
||||||
|
- Built with Golang: High performance and reliability.
|
||||||
Built with Golang: High performance and reliability.
|
- Redis Integration: Efficient data storage.
|
||||||
|
- Easy Deployment: Docker, Binary, Build it yourself
|
||||||
Redis Integration: Efficient data storage.
|
- Docker Support: ( linux/amd64, linux/arm/v6, linux/arm64/v8 )
|
||||||
|
|
||||||
Docker Support: Multi-platform compatibility ( linux/amd64, linux/arm/v6, linux/arm64/v8 )
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
#### Using Docker
|
#### Using Docker
|
||||||
(please refer to the example files!)
|
(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).
|
- latest: Latest stable release (may include breaking changes).
|
||||||
- Versioned Tags (vX, vX.X, vX.X.X): Specific release versions.
|
- 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
|
### Contributing
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue