fill out README

This commit is contained in:
Jai Flack 2020-09-16 18:30:30 +10:00
parent 2559132a1b
commit 461a252813
Signed by: jflack
GPG Key ID: 1337AEA30052317F
2 changed files with 22 additions and 3 deletions

View File

@ -1,3 +0,0 @@
# nnir-mu
mu search backend for Gnus' nnir

22
README.org Normal file
View File

@ -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]]