[nongnu] elpa/evil-goggles c405e0e58f 074/225: Update README

[ELPA Syncer]

branch: elpa/evil-goggles
commit c405e0e58f00b41c60452050271a2e69415a7d49
Author: Evgeni Kolev <evgenysw@gmail.com>
Commit: Evgeni Kolev <evgenysw@gmail.com>

    Update README
---
 README.md       | 14 ++++++--------
 evil-goggles.el |  6 ++++--
 2 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 77021e468c..585988d670 100644
--- a/README.md
+++ b/README.md
@@ -73,22 +73,20 @@ By default, all goggles' faces inherit 
`evil-goggles-default-face`, which in tur
 
 - To change the default face:
 ```emacs-lisp
-;; default is 'region, you can try 'isearch-fail
-;; to get a list of available faces on your emacs, run `M-x list-faces-display`
 (custom-set-faces
- '(evil-goggles-default-face ((t (:inherit 'isearch-fail)))))
+ '(evil-goggles-default-face ((t (:inherit 'highlight))))) ;; default is to 
inherit 'region
+;; run `M-x list-faces-display` in a fresh emacs to get a list of faces on 
your emacs
 ```
 
 - To use different faces per edit action:
 ```emacs-lisp
-(require 'diff-mode) ;; load diff-* faces
 (custom-set-faces
- '(evil-goggles-delete-face ((t (:inherit 'diff-removed))))
- '(evil-goggles-paste-face ((t (:inherit 'diff-added))))
- '(evil-goggles-yank-face ((t (:inherit 'diff-changed)))))
+ '(evil-goggles-delete-face ((t (:inherit 'shadow))))
+ '(evil-goggles-paste-face ((t (:inherit 'lazy-highlight))))
+ '(evil-goggles-yank-face ((t (:inherit 'isearch-fail)))))
 ```
 
-- This package defines the following faces:
+- The following faces are defined by evil-goggles:
 ```
 evil-goggles-default-face - inherits from `region` by default
 
diff --git a/evil-goggles.el b/evil-goggles.el
index 3271b2e79c..01c1f0110d 100644
--- a/evil-goggles.el
+++ b/evil-goggles.el
@@ -136,6 +136,10 @@ FACE-DOC is the docstring for FACE-NAME."
        ,face-doc
        :group 'evil-goggles-faces)))
 
+;;; core ends here ;;;
+
+;; helper function to inherit from diff-mode's faces
+
 (defun evil-goggles-use-diff-faces ()
   "Load `diff-mode' and use its faces for evil-goggles mode."
   (require 'diff-mode) ;; load diff-* faces
@@ -144,8 +148,6 @@ FACE-DOC is the docstring for FACE-NAME."
    '(evil-goggles-paste-face ((t (:inherit 'diff-added))))
    '(evil-goggles-yank-face ((t (:inherit 'diff-changed))))))
 
-;;; core ends here ;;;
-
 ;; delete
 
 (evil-goggles--define-switch-and-face