From f776ae3216a746d770645f8ec4d6ebe921a7c3b6 Mon Sep 17 00:00:00 2001 From: "Hahn Axel (hahn)" <axel.hahn@iml.unibe.ch> Date: Tue, 11 Jan 2022 16:31:57 +0100 Subject: [PATCH] update docs --- README.md | 4 ++-- docs/30_Examples.md | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1c1177d..e984b10 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ The specialties of this component are * 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 -Source: https://git-repo.iml.unibe.ch/iml-open-source/bash-rest-api-client +Source: <https://git-repo.iml.unibe.ch/iml-open-source/bash-rest-api-client> License: GNU GPL 3 @@ -24,4 +24,4 @@ License: GNU GPL 3 --- -[Installation](./docs/10_Installation.md) | [Usage](./docs/20_Usage.md) \ No newline at end of file +[Installation](docs/10_Installation.md) | [Usage](docs/20_Usage.md) | [Examples](docs/30_Examples.md) \ No newline at end of file diff --git a/docs/30_Examples.md b/docs/30_Examples.md index eaa02b2..c0ca4d1 100644 --- a/docs/30_Examples.md +++ b/docs/30_Examples.md @@ -11,6 +11,8 @@ Then you can follow the examples. # A first example +This is quick introduction: we make a request and have a look to a few results. + ```sh # --- init ... to flush anything of a request that was made before > http.init -- GitLab