branch: elpa/anzu
commit b791609fe89db6e8d414b6a4f414bd76e724db99
Author: Syohei YOSHIDA <[email protected]>
Commit: Syohei YOSHIDA <[email protected]>
Update document
---
README.md | 22 +++++++++++++---------
1 file changed, 13 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index 7abf3912ed..8f6be8f448 100644
--- a/README.md
+++ b/README.md
@@ -14,13 +14,13 @@ information in the mode-line in various search modes.
## Requirements
-* Emacs 24 or higher
-* `cl-lib` 0.5 or higher (you don't need to install `cl-lib` if you use Emacs
24.3 or higher)
+- Emacs 24 or higher
+- `cl-lib` 0.5 or higher (you don't need to install `cl-lib` if you use Emacs
24.3 or higher)
## Installation
-You can install `anzu.el` from [MELPA](http://melpa.org/) with `package.el`
+You can install `anzu.el` from [MELPA](https://melpa.org/) with `package.el`
```
M-x package-install anzu
@@ -29,20 +29,20 @@ You can install `anzu.el` from [MELPA](http://melpa.org/)
with `package.el`
## Basic Usage
-#### `anzu-mode`
+#### `global-anzu-mode`
-Enable anzu minor mode:
+Enable global anzu mode:
```lisp
-(anzu-mode +1)
+(global-anzu-mode +1)
```
-#### `global-anzu-mode`
+#### `anzu-mode`
-Enable global anzu mode:
+Enable anzu minor mode:
```lisp
-(global-anzu-mode +1)
+(anzu-mode +1)
```
#### `anzu-query-replace`
@@ -160,6 +160,9 @@ If this value is `nil`, `anzu.el` counts all words.

+#### `anzu-replace-threshold`(Default is `nil`)
+
+Threshold of replacement overlay. If this value is `nil`,
#### `anzu-minimum-input-length`(Default is 1)
@@ -196,6 +199,7 @@ Separator of `to` string.
'(anzu-mode-lighter "")
'(anzu-deactivate-region t)
'(anzu-search-threshold 1000)
+ '(anzu-replace-threshold 50)
'(anzu-replace-to-string-separator " => "))
```