branch: elpa/anzu
commit e9bb490b651959ccea3b05b969d850927975cadb
Author: Syohei YOSHIDA <[email protected]>
Commit: Syohei YOSHIDA <[email protected]>
Update document
---
README.md | 17 +++++++++++++++--
1 file changed, 15 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 8f91ff5c31..d9cfbd7526 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,8 @@
## Introduction
`anzu.el` is Emacs port of [anzu.vim](https://github.com/osyo-manga/vim-anzu).
-`anzu.el` shows search point information on mode-line in isearch-mode.
+`anzu.el` provides minor mode which display *current point* and *total matched*
+in various search mode.
## Screenshot
@@ -13,7 +14,7 @@
## Requirements
-* Emacs 23 or higher
+* Emacs 24 or higher
## Basic Usage
@@ -31,3 +32,15 @@ Enable global anzu mode
#### `anzu-mode-line`
Face of mode-line anzu information
+
+#### `anzu-mode-line-update-function`
+
+Function which constructs mode-line string. If you color mode-line string,
+you propertize string by yourself.
+
+```lisp
+(defun my/update-func (here total)
+ (propertize (format "<%d/%d>" here total)
+ 'face '((:foreground "yellow" :weight bold))))
+(setq anzu-mode-line-update-function 'my/update-func)
+```
