[elpa] master 0e24049 04/23: Org mode documentation.

[Artur Malabarba]

branch: master
commit 0e240493c23d591d71347093e0841f4d280d4d90
Author: Artur Malabarba <address@hidden>
Commit: Artur Malabarba <address@hidden>

    Org mode documentation.
---
 README.md  |    4 ----
 README.org |   40 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 40 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
deleted file mode 100644
index 08706b3..0000000
--- a/README.md
+++ /dev/null
@@ -1,4 +0,0 @@
-rich-minor-modes
-================
-
-Emacs package for hiding and/or highlighting the list of minor-modes in the 
mode-line.
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..bedc075
--- /dev/null
+++ b/README.org
@@ -0,0 +1,40 @@
+* rich-minority-mode
+
+Emacs package for hiding and/or highlighting the list of minor-modes
+in the mode-line.
+
+** Usage
+
+To activate the enrichment of your minor-modes list, call =M-x
+rich-minority-mode=, or add this to your init file:
+
+#+begin_src emacs-lisp
+(rich-minority-mode 1)
+#+end_src
+
+By default, this has a couple of small effects (provided as examples)
+it is up to you to customize it to your liking with the following
+three variables:
+
+- rm-excluded-modes :: List of minor mode names that will be hidden
+     from the minor-modes list. Use this to hide *only* a few modes that
+     are always active and don't really contribute information.
+- rm-included-modes :: List of minor mode names that are allowed on
+     the minor-modes list. Use this to hide *all but* a few modes.
+- rm-text-properties :: List text properties to apply to each
+     minor-mode lighter. For instance, by default we highlight =Ovwrt=
+     with a red face, so you always know if you're in =overwrite-mode=.
+
+** Installation
+
+This package is available fom Melpa, you may install it by calling
+=M-x package-install=.
+
+Alternatively, you can download it manually, place it in your
+=load-path= and require it with
+
+#+begin_src emacs-lisp
+(require 'rich-minority)
+#+end_src
+
+