From b31b6ff2ab5d94e5b6280ba3cb4db7d46267999a Mon Sep 17 00:00:00 2001
From: metamuffin <metamuffin@disroot.org>
Date: Thu, 29 Sep 2022 16:06:55 +0200
Subject: docs

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

(limited to 'readme.md')

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..9aa43e5
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,25 @@
+# staticwiki
+
+Yet another low-effort tool for rendering MediaWiki XML dumps to static html
+pages.
+
+## Features
+
+- partial wikitext support
+- can accept bzip2 compressed streams.
+- can output tar stream (could be piped to mksquashfs to recompress without
+  writing to disk)
+- horribly bad code :)
+
+## Usage
+
+- clone repo
+- obtain rustc (tested with nightly)
+- `cargo install --path .`
+- Get help: `staticwiki --help`
+- Convert to squashfs:
+  `staticwiki --bzip2 --tar < dump.xml.bz2 | mksquashfs - wiki.sfs -tar -comp zstd`
+
+## License
+
+`AGPL-3.0-only`
-- 
cgit v1.2.3-70-g09d2