From e06f894bba2e9649d707e8dbc0648a1a43137546 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Axel=20D=C3=BCrkop?= <axel.duerkop@tuhh.de> Date: Thu, 10 Feb 2022 12:59:00 +0100 Subject: [PATCH] improve headlines MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Axel Dürkop <axel.duerkop@tuhh.de> --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 180f351..9a09b00 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,8 @@ For more background, see the initial [discussion](https://github.com/hackmdio/co - `wget` (install via `apt install wget` or `brew install wget` on Mac) - `jq` (install via `apt install jq` or `brew install jq` on Mac) +### Instructions + Clone the repository. $ git clone https://github.com/hedgedoc/cli @@ -48,12 +50,12 @@ Test your configuration by creating a new note with FREELY access and no login r Check for the document in the browser by concatenating the address of your server and the `<note_id>`. -## Documentation - -It's not necessary to authenticate against the server in order to make use of `hedgedoc-cli`. But without authentication you won't have access to the non-FREELY documents and everything that's accessible behind the login. +## Configuration and usage ### Variants of authentication +It's not necessary to authenticate against the server in order to make use of `hedgedoc-cli`. But without authentication you won't have access to the non-FREELY documents and everything that's accessible behind the login. + #### Authenticate with cookie Authentication with a cookie is so far the only way if you login with GitLab and the like. Use browser extensions like [Get cookies.txt](https://chrome.google.com/webstore/detail/get-cookiestxt/bgaddhkoddajcdgocldbbfleckgcbcid) to store the cookie in `key.conf`. -- GitLab