diff --git a/readme b/readme index c1ac13c..882a845 100644 --- a/readme +++ b/readme @@ -7,6 +7,21 @@ simple URL shortener usage ----- +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 + + susmng [-s pls.cx] delete -l shortlink -v confirm + +susmng will assume the first server in the 'secrets' section if the -s flag is +not provided. + + +installation +------------ + running the server 1. generate the secret used to create and delete shortlinks