branch: externals/diminish
commit 6ec6ebc391371418efc6c98d70b013f34af5a2ee
Author: conao3 <con...@gmail.com>
Commit: Martin Yrjölä <martin.yrj...@gmail.com>
add more usage
---
README.md | 18 ++++++++++++++----
1 file changed, 14 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 96b466ef6f..23d78ef847 100644
--- a/README.md
+++ b/README.md
@@ -23,12 +23,22 @@ 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")
+
+(diminish 'rainbow-mode) ; Hide lighter
from mode-line
+(diminish 'rainbow-mode " Rbow") ; Replace
rainbow-mode lighter with " Rbow"
+(diminish 'rainbow-mode 'rainbow-mode-lighter) ; Use
raingow-mode-lighter variable value
+(diminish 'rainbow-mode '(" " "R-" "bow")) ; Replace
rainbow-mode lighter with " R-bow"
+(diminish 'rainbow-mode '((" " "R") "/" "bow")) ; Replace
rainbow-mode lighter with " R/bow"
+(diminish 'rainbow-mode '(:eval (format " Rbow/%s" (+ 2 3)))) ; Replace
rainbow-mode lighter with " Rbow/5"
+(diminish 'rainbow-mode ; Replace
rainbow-mode lighter with greened " Rbow"
+ '(:propertize " Rbow" face '(:foreground "green")))
+(diminish 'rainbow-mode ; If
rainbow-mode-mode-linep is non-nil " Rbow/t"
+ '(rainbow-mode-mode-linep " Rbow/t" " Rbow/nil"))
+(diminish 'rainbow-mode '(3 " Rbow" "/" "s")) ; Replace
rainbow-mode lighter with " Rb"
```
+Ref: [Emacs manual - The Data Structure of the Mode
Line](https://www.gnu.org/software/emacs/manual/html_node/elisp/Mode-Line-Data.html).
+
John Wiegley's
[use-package](https://github.com/jwiegley/use-package#diminishing-and-delighting-minor-modes)
macro also has support for diminish.el.
