From 3ef701b65baf3cfe9e03b102c9d838f9430b01d1 Mon Sep 17 00:00:00 2001
From: Fenris Wolf <fenris@folksprak.org>
Date: Mon, 30 Sep 2024 09:17:37 +0200
Subject: [PATCH] [add] readme

---
 readme.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..9565d0c
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,30 @@
+# wiki-js-cli
+
+Inoffizieller CLI-Client für [Wiki.js](https://js.wiki/)
+
+
+## Erstellung
+
+### Voraussetzungen
+
+- GNUMake
+- TypeScript-Compiler
+
+
+### Anweisungen
+
+- `tools/build` ausführen
+- nach dem Erstellen, sollte sich im Verzeichnis `build` die ausführbare Datei `wiki-js-cli` befinden
+
+
+## Verwendung
+
+### Voraussetzungen
+
+- NodeJS
+
+
+### Anweisungen
+
+- siehe `wiki-js-cli -h`
+