]> code.delx.au - gnu-emacs-elpa/blobdiff - README.md
Reduce warnings during byte-compilation; don't error b-c in <24.4
[gnu-emacs-elpa] / README.md
index a0d5168a53d56e4abdfbf3da18c67f1fab59717f..ab8c9d81e25031b5a87fcc172033b2651a8892ed 100644 (file)
--- a/README.md
+++ b/README.md
@@ -15,6 +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` 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
@@ -46,10 +48,9 @@ Emacs 24+. On OS X, Emacs 24.3 or higher is recommended.
 Notes\r
 =====\r
 \r
-* Since it uses the corresponding VC diff command, it's only accurate when the\r
-  buffer is in saved state. Highlighting changes "on the fly" might be better,\r
-  maybe we can do something similar to `highlight-markup-buffers` with a hidden\r
-  buffer containing the unmodified copy.\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