chore: updates readme

This commit is contained in:
Tom Andrade 2022-05-19 10:30:30 +02:00
parent 1684e44c47
commit 53caaa997b
Signed by: wolvie
GPG Key ID: 31AAB07872E82669

View File

@ -9,20 +9,26 @@ Short is a very simple url shortener build in golang using gorilla/mux for url r
```shell ```shell
Usage of short: Usage of short:
-addr string -addr string
Address to listen for connections (default "localhost") Address to listen for connections (default "localhost")
-cleanup int
Cleanup interval in hours, default 1 (default 1)
-domain string -domain string
Domain to write to the URLs (default "localhost") Domain to write to the URLs (default "localhost")
-dump string -dumpFile string
Path to the file to dump the kv db (default "urls.json") urls.json (default "Path to the file to dump the kv db")
-exp int
Default expiration time in hours, default 240 (default 240)
-http
proto to the base URL (HTTPS://localhost/path/... no real https here just to set the url (for like a proxy offloading https
-path string -path string
Path to the base URL (https://localhost/PATH/... remember to append a / at the end Path to the base URL (https://localhost/PATH/...
-port string -port int
Port to listen for connections (default "8080") Port to listen for connections (default 8080)
-proto string -size int
proto to the base URL (HTTPS://localhost/path/... no real https here just to set the url (for like a proxy offloading https (default "https") Define the size of the shortened String (default 10)
-urlsize int -urlPort int
Define the size of the shortened String, default 10 (default 10) Port to use for building URLs (default 443)
-v prints current version -v prints current version
``` ```
Includes a Dockerfile to for a standalone docker image. Includes a Dockerfile to for a standalone docker image.