diff --git a/README.md b/README.md index bef8d5b..1ebca30 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,19 @@ ![](https://git.ucode.space/Phil/goshorly/badges/main/pipeline.svg) # goshorly -An easy self-hosted Link shortener in Golang with Redis <3 - -[Live-Demo](https://gly.one) | Stable Build - +An easy self-hosted Link shortener in Golang with Redis <3 [Live-Demo](https://gly.one) +--- +## Supported architectures +### Docker +- amd64, arm64 +- other versions can be build manually (via docker build) +## Binary Build +- linux (amd64,arm64) +- darwin (amd64,arm64) +- windows (amd64) +- other versions can be build manually (via go build) +--- **WARNING:** - goshorly is in an early stage, it is not an Final Version! (Pre-Release Status v0.1.X) @@ -14,6 +22,8 @@ If you have an feature request, please do not hesitate to open an issue or merge Available Docker tags: - https://git.ucode.space/Phil/goshorly/container_registry/1 + +## Install with Docker Installation with Docker-Compose (with no reverse proxy / own proxy): ```bash mkdir goshorly @@ -32,3 +42,6 @@ mv docker-compose-proxy.yml docker-compose.yml nano docker-compose.yml # Change the command line on caddy to your domain & environment variables to your needs docker-compose up -d ``` + +## Install with Binary version +- WIP \ No newline at end of file