From 963b9fa708ec9894aee4c02d417b1317a85ea9f8 Mon Sep 17 00:00:00 2001
From: kekskurse <git@ekskurse.de>
Date: Sun, 6 Jul 2025 17:23:35 +0200
Subject: [PATCH] docs: Readme

---
 Readme.md | 34 ++++++++++++++++++++++++++++++++--
 1 file changed, 32 insertions(+), 2 deletions(-)

diff --git a/Readme.md b/Readme.md
index bbbfae8..9dda472 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,2 +1,32 @@
-URL:
-https://wikipress.s3.fr-par.scw.cloud/wikipress/wikipress/wikipress
+# Wikipress
+Create a wiki like static html page base on markdown files, if the content is a git repro it also show the history.
+
+# Install
+Get the last Version and make it executable
+```
+wget https://wikipress.s3.fr-par.scw.cloud/wikipress/wikipress/wikipress
+chmod u+x wikipress
+```
+
+
+# Content
+Create a foldern with the content of the page, e.g. `/home/foo/mywikipage` and add some MArkedown files. The markdown file contains spme header information in a `key: value` format, than a seperator `---` and than the markdown content. For an example the content of a file look like this:
+
+```
+title: Startseite
+order: 10
+---
+## Links
+* [kekskurse.de](https://kekskurse.de/)
+
+```
+
+# Generate HTML Page
+To generate a HTML Page out of the content you can run wikipress with the `--path` parameter, if the content is not a git repro you also need to add the `--no-git` flag. 
+
+```
+./wikipress --path /home/foo/mywikipage --no-git
+```
+
+# Example
+* [wiki.kekskurse.de](https://wiki.kekskurse.de)