mirror of
https://codeberg.org/vlw/curl.git
synced 2025-09-13 16:23:41 +02:00
doc(fix): README nit fixes (#1)
Add public domain mark badge as well as some other fixes to README. Reviewed-on: https://codeberg.org/vlw/curl/pulls/1 Co-authored-by: vlw <victor@vlw.se> Co-committed-by: vlw <victor@vlw.se>
This commit is contained in:
parent
ee7f36e1c5
commit
d9fa939da5
1 changed files with 8 additions and 5 deletions
13
README.md
13
README.md
|
@ -1,15 +1,18 @@
|
||||||
A simple curl wrapper written in bash that can be used to make HTTP requests to API endpoints.
|

|
||||||
|
|
||||||
|
# A simple curl wrapper written in bash that can be used to make HTTP requests to API endpoints.
|
||||||
|
|
||||||

|

|
||||||
*This is how I use this script*
|
|
||||||
|
I use this script with windows set up like this in code-server.
|
||||||
|
|
||||||
# Files
|
# Files
|
||||||
This script uses separate files for various request options. Create these files in the same directory as `curl.sh`.
|
This script uses separate files for various request options. Create these files in the same directory as `curl.sh`.
|
||||||
|
|
||||||
## `params.txt`
|
## `params.txt`
|
||||||
URL search parameters
|
URL search parameters.
|
||||||
|
|
||||||
## `paylod.json`
|
## `paylaod.json`
|
||||||
JSON request body that will be sent with all requests (except `GET`).
|
JSON request body that will be sent with all requests (except `GET`).
|
||||||
|
|
||||||
## `key.txt`
|
## `key.txt`
|
||||||
|
@ -19,7 +22,7 @@ JSON request body that will be sent with all requests (except `GET`).
|
||||||
Optional empty file that when present will disable SSL peer validation - for self-signed certificates etc.
|
Optional empty file that when present will disable SSL peer validation - for self-signed certificates etc.
|
||||||
|
|
||||||
# Make a request
|
# Make a request
|
||||||
Run the `curl.sh` file from your shell and pass it two parametes for URL and request method
|
Run the `curl.sh` file from your shell and pass it two parametes for URL and request method.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
./curl.sh https://example.com GET
|
./curl.sh https://example.com GET
|
||||||
|
|
Loading…
Add table
Reference in a new issue