[nongnu] elpa/anzu 4cc1b6c9e0 030/288: Merge pull request #7 from bbatsov/doc-improvement

[ELPA Syncer]

branch: elpa/anzu
commit 4cc1b6c9e0c7bbc961bd0982b40d14aeccaa4931
Merge: 16fc5810b3 8f91b00c91
Author: Syohei YOSHIDA <syo...@gmail.com>
Commit: Syohei YOSHIDA <syo...@gmail.com>

    Merge pull request #7 from bbatsov/doc-improvement
    
    Improve the documentation a bit
---
 README.md | 24 ++++++++++++++++--------
 anzu.el   |  9 +++++----
 2 files changed, 21 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 20e55190c2..04da844e7d 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,9 @@
 
 ## Introduction
 
-`anzu.el` is Emacs port of [anzu.vim](https://github.com/osyo-manga/vim-anzu).
-`anzu.el` provides minor mode which display *current point* and *total matched*
-in various search mode.
+`anzu.el` is an Emacs port of 
[anzu.vim](https://github.com/osyo-manga/vim-anzu).
+`anzu.el` provides a minor mode which displays *current match* and *total 
matches*
+information in the mode-line in various search mode.
 
 
 ## Screenshot
@@ -30,11 +30,19 @@ You can install `anzu.el` from 
[MELPA](http://melpa.milkbox.net/) with `package.
 
 #### `anzu-mode`
 
-Enable anzu minor mode
+Enable anzu minor mode:
+
+```lisp
+(anzu-mode)
+```
 
 #### `global-anzu-mode`
 
-Enable global anzu mode
+Enable global anzu mode:
+
+```lisp
+(global-anzu-mode)
+```
 
 ## Customization
 
@@ -74,7 +82,7 @@ For example, show search information tail of 
`minor-mode-alist`
 
 #### `anzu-use-migemo`(Default is `nil`)
 
-Set non-nil` if you use [migemo](https://github.com/emacs-jp/migemo).
+Set to `t` if you use [migemo](https://github.com/emacs-jp/migemo).
 
 #### `anzu-mode-lighter`
 
@@ -82,10 +90,10 @@ Default is ` Anzu`.
 
 #### `anzu-regexp-search-commands`
 
-Command which use regexp input. If last command is member of this list,
+Commands which have regexp input. If the last command is a member of this list,
 `anzu.el` treats input as regular expression.
 
-Default is `'(isearch-forward-regexp isearch-backward-regexp)`.
+The default value is `'(isearch-forward-regexp isearch-backward-regexp)`.
 
 
 ## Sample Configuration
diff --git a/anzu.el b/anzu.el
index da115e63e7..2b6964d3ba 100644
--- a/anzu.el
+++ b/anzu.el
@@ -21,11 +21,12 @@
 
 ;;; Commentary:
 
-;; `anzu.el' is Port of `anzu.vim'.
+;; `anzu.el' is an Emacs port of `anzu.vim'.
 ;;
-;; `anzu.el' provides minor-mode which display 'current-posion/total matches'
-;; to mode-line in various search modes. You can understand that how many
-;; does your searched word match in current buffer.
+;; `anzu.el' provides a minor mode which displays 'current match/total
+;; matches' in the mode-line in various search modes.  This makes it
+;; easy to understand how many matches there are in the current buffer
+;; for your search query.
 
 ;; To use this package, add following code to your init.el or .emacs
 ;;   (require 'anzu)