]> code.delx.au - gnu-emacs-elpa/commitdiff
Reword the recent README changes
authorDmitry Gutov <dgutov@yandex.ru>
Sat, 5 Sep 2015 03:48:35 +0000 (06:48 +0300)
committerDmitry Gutov <dgutov@yandex.ru>
Sat, 5 Sep 2015 03:48:35 +0000 (06:48 +0300)
README.md

index 20274bbc122269dda6bc33fc5c0c779c8c77229b..ab8c9d81e25031b5a87fcc172033b2651a8892ed 100644 (file)
--- a/README.md
+++ b/README.md
@@ -15,7 +15,8 @@ The package also contains auxiliary modes:
 * `diff-hl-margin-mode` changes the highlighting function to\r
   use the margin instead of the fringe.\r
 * `diff-hl-amend-mode` shifts the reference revision back by one.\r
-* `diff-hl-flydiff-mode` enables diffing unsaved changes\r
+* `diff-hl-flydiff-mode` implements highlighting changes on the fly.\r
+  It requires Emacs 24.4 or newer.\r
 \r
 Check out the Commentary section in each respective file for the usage\r
 instructions.\r
@@ -47,6 +48,10 @@ Emacs 24+. On OS X, Emacs 24.3 or higher is recommended.
 Notes\r
 =====\r
 \r
+* By default `diff-hl-mode` uses the corresponding VC diff command, so\r
+  it's only accurate when the buffer is in saved state. Check out\r
+  `diff-hl-flydiff-mode`, it aims to handle unsaved buffers as well.\r
+\r
 * We conflict with other modes when they put indicators on the fringe,\r
   such as [Flycheck](https://github.com/flycheck/flycheck). This is\r
   rarely a significant problem, since if you're using such a mode,\r