Skip to content

Commit

Permalink
doc: update Readme to show how to use releases
Browse files Browse the repository at this point in the history
  • Loading branch information
Hoverth committed Nov 18, 2024
1 parent 7bb7938 commit cb404d7
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

##### super simple URL shortener service

![logo](./assets/favicon.png)
![logo](./assets/favicon.png)

A very lightweight URL shortener.

Expand All @@ -14,7 +14,9 @@ You can use ssurlss standalone by manually compiling & installing it in a direct

### Docker

You can build the docker image using supplied `docker-compose.yml` using `docker-compose up` in a clone of this repo, or change the `build: .` to `build: https://github.com/Hoverth/ssurlss.git` to keep your directory clean.
You can build the docker image using supplied `docker-compose.yml` using `docker-compose up` in a clone of this repo.

To use a specific release, change the `build: .` to `build: https://github.com/Hoverth/ssurlss.git#v1.1.0` (just change the `v1.1.0` to whatever [release](https://github.com/Hoverth/ssurlss/releases) you want to target).

## Configuration

Expand All @@ -29,7 +31,6 @@ The following list is formatted as: `- toml_name (ENVNAME, default value) Notes`
- allow_new (ALLOWNEW/DISALLOWNEW, `true`) Setting either envvar to 1 will set the relevant value in the config.
- entries_len (no envvar, `0`) A helpful tracking value for admin purposes, no environment variable and not used anywhere (write-only).


## License

This project is licensed under the AGPL v3. See `LICENSE` for details.

0 comments on commit cb404d7

Please sign in to comment.