branch: externals/diminish
commit 84157483fb7c31a5d5359aaa51d9b7aaea9b17cc
Author: Martin Yrjölä <martin.yrj...@gmail.com>
Commit: Martin Yrjölä <martin.yrj...@gmail.com>
Update README.md
---
README.md | 37 ++++++++++++++++++++++++++++++++++++-
1 file changed, 36 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 6e980e8a19..4080b41bec 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,37 @@
# diminish.el
-Diminished modes are minor modes with no modeline display
+
+Introduction
+============
+
+> When we diminish a mode, we are saying we want it to continue doing its
+> work for us, but we no longer want to be reminded of it. It becomes a
+> night worker, like a janitor; it becomes an invisible man; it remains a
+> component, perhaps an important one, sometimes an indispensable one, of
+> the mechanism that maintains the day-people's world, but its place in
+> their thoughts is diminished, usually to nothing. As we grow old we
+> diminish more and more such thoughts, such people, usually to nothing.
+> -- Will Mengarini
+
+This package implements hiding or abbreviation of the mode line displays
+(lighters) of minor-modes.
+
+Quick start
+===========
+
+```emacs-lisp
+(require 'diminish)
+;; Hide jiggle-mode lighter from mode line
+(diminish 'jiggle-mode)
+;; Replace abbrev-mode lighter with "Abv"
+(diminish 'abbrev-mode "Abv")
+```
+
+John Wiegley's
+[use-package](https://github.com/jwiegley/use-package#diminishing-minor-modes)
+macro also has support for diminish.el.
+
+Acknowledgments
+===============
+
+diminish.el was created by Will Mengarini on 19th of February 1998 and is now
+maintained by [Martin Yrjölä](https://github.com/myrjola).
