From e68d36bad41140611e9288307623c9114ccf8145 Mon Sep 17 00:00:00 2001
From: Martin Morgenstern <martin.morgenstern1@tu-dresden.de>
Date: Fri, 3 Feb 2023 16:29:17 +0100
Subject: [PATCH] Improve the documentation

---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
index 88a994c..ff738f5 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,8 @@ Its only dependency is Python >= 3.7 (use `python3 -V` to check your version).
 First of all, you need to extract the value of the `connect.sid` browser cookie for the
 particular CodiMD instance that you use (e.g., `md.inf.tu-dresden.de`).
 
+This procedure is necessary because the CodiMD login is handled externally by Keycloak.
+
 **WARNING**: the value of the cookie is your session ID and as such, **should be treated like a
 password**. Don't share it with others!
 
@@ -34,6 +36,10 @@ Clone this repository to a path of your liking and just execute `./codimd_export
 shell. The script will ask for your session id and download the notes to the relative path
 `./codimd-documents`.
 
+Please note that your CodiMD history might reference already deleted notes or notes you no
+longer have access to. The URLs of these inaccessible notes are listed as part of the
+script's output.
+
 
 ### Example
 
-- 
GitLab