Add readme

1 files changed, 19 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c8f1630
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# Lowdown Markdown filter
+
+This is a simple Markdown filter for cgit. The substantive parts of the file
+are copied verbatim from the example in `lowdown_file(3)`, with the
+`LOWDOWN_STANDALONE` flag removed so that the program outputs an HTML fragment
+rather than a full document.
+
+This requires the `lowdown` package on OpenBSD. Run `make install` to compile
+the program and install it at `/var/www/bin/md-filter`. Add the following line
+to the `cgitrc` file to enable the filter:
+
+    about-filter=/bin/md-filter
+
+## See also
+
+- `lowdown(3)`
+- `lowdown(5)`
+- `lowdown_file(3)`
+- `cgitrc(5)`