readonly/mirror-chhoto-url
1
0
Fork 0
mirror of https://github.com/minoplhy/chhoto-url.git synced 2024-11-22 01:06:46 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Fix typo, and slight change in grammar

Browse Source
This commit is contained in:
SinTan1729 2024-04-01 00:47:25 -05:00
parent 2594051a54
commit 917be6ade4
No known key found for this signature in database
GPG Key ID: EB3E68BFBA25C85F
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -122,7 +122,7 @@ default, the auto-generated links are adjective-name pairs. You can use UIDs by
the `slug_style` variable to `UID`. You can also set the length of those slug by setting
the `slug_length` variable. It defaults to 8, and a minimum of 4 is supported.
## CLI usage instructions
## Instructions for CLI usage
The application can be used from the terminal using something like `curl`. In all the examples
below, replace `http://localhost:4567` with where your instance of `chhoto-url` is accessible.
@ -136,7 +136,7 @@ request, please add `-b cookie.txt` to use this authentication cookie.
To add a link, do
```bash
curl -X POST -d '{"shhortlink":"<shortlink>", "longlink":<longlink>}' http://localhost:4567/api/new
curl -X POST -d '{"shortlink":"<shortlink>", "longlink":"<longlink>"}' http://localhost:4567/api/new
```
Send an empty `<shortlink>` if you want it to be auto-generated. The server will reply with the generated shortlink.