chore: usage instructions

This commit is contained in:
pommee
2025-02-09 16:41:12 +01:00
parent 4f44007cb8
commit 8760a7ef96
3 changed files with 13 additions and 2 deletions

View File

@@ -15,6 +15,9 @@ publish:
docker buildx rm multiarch-builder
start:
docker compose up -d
lint:
golangci-lint run

View File

@@ -42,12 +42,20 @@ If the installer fails, you can manually download binaries from the [releases pa
### Option 2: Docker Installation
Run goaway in a containerized environment. This requires a clone of this repository and running the following in project root:
Run goaway in a containerized environment. There are two options:
```bash
First one requires a clone of this repository and running the following in project root:
```shell
make start
```
Second alternative is using the published docker image.
```shell
docker run --name goaway -p 8080:8080 -p 53:53 pommee/goaway:latest
```
## 🚀 Getting Started
### Basic Usage

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 284 KiB