From 461a252813d1c502476186bc6446a68645db1a6d Mon Sep 17 00:00:00 2001
From: Jai Flack <jaiflack@protonmail.com>
Date: Wed, 16 Sep 2020 18:30:30 +1000
Subject: [PATCH] fill out README

---
 README.md  |  3 ---
 README.org | 22 ++++++++++++++++++++++
 2 files changed, 22 insertions(+), 3 deletions(-)
 delete mode 100644 README.md
 create mode 100644 README.org

diff --git a/README.md b/README.md
deleted file mode 100644
index 5efc288..0000000
--- a/README.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# nnir-mu
-
-mu search backend for Gnus' nnir
\ No newline at end of file
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..12cce7e
--- /dev/null
+++ b/README.org
@@ -0,0 +1,22 @@
+#+TITLE: nnir-mu
+
+An mu search backend for Gnus' nnir.
+
+Of course mu is required and must be set up properly for the groups
+you want to search. This works almost identically to the current
+notmuch engine.
+
+* Enable
+To start using it can be as simple as;
+#+begin_src emacs-lisp
+  (add-to-list 'load-path "/path/to/nnir-mu")
+  (require 'nnir-mu)
+
+  ;; Then, like any other nnir backend
+  (custom-set-variables
+   '(nnir-method-default-engines '((nnmaildir . mu))))
+  ;; or
+  (setq nnir-method-default-engines '((nnmaildir . mu)))
+#+end_src
+
+For configuration options see the header of [[./nnir-mu.el]]