jlelse/GoShort
1
Fork 0
Code Packages

Update documentation

Browse Source
This commit is contained in:
Jan-Lukas Else 2020-03-30 10:11:21 +02:00
parent c91cdb80d0
commit 280c68d77a
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -18,13 +18,21 @@ These are optional config values:
See the `example-config.yaml` file for an example configuration.
## Authentication
The preferred authentication method is Basic Authentication. If you try to create, modify or delete a short link, in the browser a popup will appear asking for username and password. Enter just the password you configured. Alternatively you can append a URL query parameter `password` with your configured password.
## Create a new short link
To create a new short link, open "`shortUrl` + `/s?url=` + URL to shorten" in the browser. If you want, you can append `&slug=` with the preferred slug.
To create a new short link, call "`shortUrl` + `/s?url=` + URL to shorten". If you want, you can append `&slug=` with the preferred slug.
## Update a short link
To update a short link, call "`shortUrl` + `/d?slug=` + slug to update + `&new=` + new long URL"
## Delete a short link
To delete a short link, open "`shortUrl` + `/d?slug=` + slug to delete" in the browser.
To delete a short link, call "`shortUrl` + `/d?slug=` + slug to delete".
## License