Skip to content

Commit

Permalink
docs: Update README to include configuration steps
Browse files Browse the repository at this point in the history
  • Loading branch information
maxnatamo committed Jul 27, 2024
1 parent fb7ed8a commit 8afa7c8
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ docker run -d \
ghcr.io/fetcharr/fetcharr:latest
```

If you prefer a more *declarative* way of starting Fetcharr, use this `compose.yaml` file:
If you prefer a more *declarative* way of starting Fetcharr, you can use this `compose.yaml` file:

```yaml
services:
Expand All @@ -62,6 +62,9 @@ services:
restart: unless-stopped
```
Copy the [`config.example.yaml`](./config.example.yaml)-file to your configuration folder as `config.yaml` and edit it to your liking.
When you've changed the config-file, remember to restart Fetcharr for it to take effect.

## 📝 Contributing

If you want to contribute, great! We'd love your help!
Expand Down

0 comments on commit 8afa7c8

Please sign in to comment.