From 2da866325c9dbabaf913192100842bfa1b34ed09 Mon Sep 17 00:00:00 2001 From: Alvie Rahman Date: Thu, 26 May 2022 16:14:24 +0100 Subject: [PATCH] update readme to markdown file --- readme => readme.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) rename readme => readme.md (60%) diff --git a/readme b/readme.md similarity index 60% rename from readme rename to readme.md index 882a845..885e589 100644 --- a/readme +++ b/readme.md @@ -1,17 +1,15 @@ -sus -=== +# sus simple URL shortener -usage ------ +## usage -creating a new shortlink at https://pls.cx/shortlink +- creating a new shortlink at https://pls.cx/shortlink susmng [-s pls.cx] create -l shortlink -v https://example.com -deleting the shortlink https://pls.cx/shortlink +- deleting the shortlink https://pls.cx/shortlink susmng [-s pls.cx] delete -l shortlink -v confirm @@ -19,10 +17,9 @@ susmng will assume the first server in the 'secrets' section if the -s flag is not provided. -installation ------------- +## installation -running the server +### running the server 1. generate the secret used to create and delete shortlinks @@ -32,7 +29,12 @@ running the server docker-compose up -d --build -setting up susmng +#### server environment variables + +- `SECRET` - the secret used for signature verification +- `LISTEN_ADDRESS` - the address the server is listening on (default is `0.0.0.0:80`) + +### setting up susmng 1. install susmng