From 6087ce400f291769cfdbcad5b53feba79382d896 Mon Sep 17 00:00:00 2001
From: Johannes Rothe <rothe@magazino.eu>
Date: Thu, 15 Sep 2022 08:23:18 +0200
Subject: [PATCH] Fill Readme with info

---
 README.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e27467f..d6dcd4d 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,22 @@
-# confluence-space-exporter
+# Confluence space exporter
+A little program to download Confluence spaces for offline usage or sharing with others.
 
+An index.html is exported which reflects the pagetree of the space. Optionally attachments
+are downloaded as well. Some cleanup is done to the Confluence specific HTML to be able
+to render it with normal CSS.
+
+## Usage
+```
+confluence-space-exporter --baseurl BASEURL --spacekey SPACEKEY --user USER --token TOKEN [--attachments]
+
+Options:
+  --baseurl BASEURL      Base URL of the Confluence instance (required), i.e. https://company.atlassian.net
+  --spacekey SPACEKEY    Spacekey to export (required)
+  --user USER            User used for authentication (required)
+  --token TOKEN          Token used for authentication (required)
+  --attachments, -a      Download attachments
+  --help, -h             display this help and exit
+```
+
+After a successful export you find a folder named like the space. Open the `index.html`
+in that folder with your browser to get started.