From aaaa9ab0643b545f846741a0f138c17e3b6b5d05 Mon Sep 17 00:00:00 2001 From: "Hahn Axel (hahn)" <axel.hahn@iml.unibe.ch> Date: Tue, 3 Mar 2020 08:57:20 +0100 Subject: [PATCH] update docs --- readme.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 0b81620..61c213c 100644 --- a/readme.md +++ b/readme.md @@ -4,12 +4,13 @@ This is a bash solution to script REST API calls. The specialties of this component are -* It was build to simplify http calls and use it in scripts +* 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 tehe response body or http.getResponseHeader for the Http response header -* The response can be stored ... and reimported later. After import you can use the http.get* functions to fetch results from the former request. * This component wraps curl - ist supports any http method * works with anonymous requests and Basic Authentication +* 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 Source: https://git-repo.iml.unibe.ch/iml-open-source/bash-rest-api-client @@ -26,6 +27,18 @@ License: GNU GPL 3 ## Installation ## +**Download** the archive i.e. as zip: + +https://git-repo.iml.unibe.ch/iml-open-source/bash-rest-api-client/-/archive/master/bash-rest-api-client-master.zip + +(see other formats at the download button on https://git-repo.iml.unibe.ch/iml-open-source/bash-rest-api-client) + +or **Git clone** + +``` +$ git clone https://git-repo.iml.unibe.ch/iml-open-source/bash-rest-api-client.git +``` + Copy the *rest-api-client.sh* anywhere you want. -- GitLab