diff --git a/README.md b/README.md index 0bfbdb1892809b5f7dc9dfde866a411fe58f520b..3e85997fded3b6751fb14ed59368499116a387fd 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # Bash REST API client +A set of class like functions with a <code>http.</code> prefix. This is a bash solution to script REST API calls. The specialties of this component are @@ -7,8 +8,8 @@ The specialties of this component are * It was build to simplify http calls and handle http response for scripts * After making a request the response stays is in memory. There is no output to any file to grep something or to cleanup after usage. * Its functions feel a bit like class methods, i.e. http.getResponse to get the response body or http.getResponseHeader for the Http response header -* This component wraps curl - ist supports any http method -* works with anonymous requests and Basic Authentication +* This component wraps curl - it supports any http method +* works with anonymous requests and authentication / authorization: (Basic authentication, Authorization header (tokens, NTLM) or any other request header variable * The response can be stored ... and reimported later. After import you can use the http.get* functions to fetch results from the former request. * Caching support for GET requests with a given TTL: if you repeat a request to the same url and ttl was not reached yet then you continue with the cached result diff --git a/docs/10_Introduction.md b/docs/10_Introduction.md index 4c566a394130d83c5bc7ed426e0422c2d0aad94a..84d7c2be1d146d64503fa4f67e17e8e3901eaa32 100644 --- a/docs/10_Introduction.md +++ b/docs/10_Introduction.md @@ -9,8 +9,8 @@ The specialties of this component are * It was build to simplify http calls and handle http response for scripts * After making a request the response stays is in memory. There is no output to any file to grep something or to cleanup after usage. * Its functions feel a bit like class methods, i.e. http.getResponse to get the response body or http.getResponseHeader for the Http response header -* This component wraps curl - ist supports any http method -* works with anonymous requests and Basic Authentication +* This component wraps curl - it supports any http method +* works with anonymous requests and authentication / authorization: (Basic authentication, Authorization header (tokens, NTLM) or any other request header variable * The response can be stored ... and reimported later. After import you can use the http.get* functions to fetch results from the former request. * Caching support for GET requests with a given TTL: if you repeat a request to the same url and ttl was not reached yet then you continue with the cached result diff --git a/docs/_index.md b/docs/_index.md index 2300b3ad7ebfe98cdcef1677fa3e1cec39c5dc8c..2801ff2997b37f07936c4de18e998d96e6b68ed2 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -1,7 +1,7 @@ <html> <div class="hero"> <h2>Bash REST API client</h2> - + A set of class like functions with a <code>http.</code> prefix. </div> </html>