doc: add README.md

README.md

@@ -0,0 +1,37 @@
+A simple curl wrapper written in bash that can be used to make HTTP requests to API endpoints.
+
+![screenshot](https://href.vlw.se/0194ea19-faa6-77b5-8fe1-b1459a12ea84)
+*This is how I use this script*
+
+# Files
+This script uses separate files for various request options. Create these files in the same directory as `curl.sh`.
+
+## `params.txt`
+URL search parameters
+
+## `paylod.json`
+JSON request body that will be sent with all requests (except `GET`).
+
+## `key.txt`
+[HTTP Authentication Bearer Token](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)
+
+## `disable_peer_validation`
+Optional empty file that when present will disable SSL peer validation - for self-signed certificates etc.
+
+# Make a request
+Run the `curl.sh` file from your shell and pass it two parametes for URL and request method
+
+```sh
+./curl.sh https://example.com GET
+```
+
+The response body will be printed to stdout.
+
+*Example*
+```
+vlw@example:/curl$ ./curl.sh https://example.com GET
+GET https://example.com?foo=bar
+
+"This is an example response body in plaintext"
+vlw@example:/curl$
+```