alvierahman90/sus
1
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

update readme to markdown file

Browse Source
This commit is contained in:
Akbar Rahman 2022-05-26 16:14:24 +01:00
parent bea1cae589
commit 2da866325c
Signed by: alvierahman90
GPG Key ID: 20609519444A1269
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
readme → readme.md
View File

@ -1,17 +1,15 @@
sus # sus
===
simple URL shortener 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 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 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. not provided.
installation ## installation
------------
running the server ### running the server
1. generate the secret used to create and delete shortlinks 1. generate the secret used to create and delete shortlinks
@ -32,7 +29,12 @@ running the server
docker-compose up -d --build 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 1. install susmng