X-Git-Url: https://code.delx.au/gnu-emacs-elpa/blobdiff_plain/f727b53504076bf752e14b8898a99968ae1db2d4..8f6fe36e1ad23834e9b772e8fcdfe85d5eb47356:/packages/diff-hl/README.md

diff --git a/packages/diff-hl/README.md b/packages/diff-hl/README.md
index 325f53ea5..ab8c9d81e 100644
--- a/packages/diff-hl/README.md
+++ b/packages/diff-hl/README.md
@@ -15,6 +15,8 @@ The package also contains auxiliary modes:
 * `diff-hl-margin-mode` changes the highlighting function to
   use the margin instead of the fringe.
 * `diff-hl-amend-mode` shifts the reference revision back by one.
+* `diff-hl-flydiff-mode` implements highlighting changes on the fly.
+  It requires Emacs 24.4 or newer.
 
 Check out the Commentary section in each respective file for the usage
 instructions.
@@ -46,10 +48,9 @@ Emacs 24+. On OS X, Emacs 24.3 or higher is recommended.
 Notes
 =====
 
-* Since it uses the corresponding VC diff command, it's only accurate when the
-  buffer is in saved state. Highlighting changes "on the fly" might be better,
-  maybe we can do something similar to `highlight-markup-buffers` with a hidden
-  buffer containing the unmodified copy.
+* By default `diff-hl-mode` uses the corresponding VC diff command, so
+  it's only accurate when the buffer is in saved state. Check out
+  `diff-hl-flydiff-mode`, it aims to handle unsaved buffers as well.
 
 * We conflict with other modes when they put indicators on the fringe,
   such as [Flycheck](https://github.com/flycheck/flycheck). This is
@@ -63,6 +64,9 @@ Notes
 
 * Frame-local and buffer-local values of `line-spacing` are not supported.
 
+* Fringe width up to 16 works best (because we can't define a bitmap
+  with width above that number).
+
 * [emacs-git-gutter](https://github.com/syohex/emacs-git-gutter) shows
   indicators in the margin by default, allows you to customize how the
   indicators look more easily, and has a "stage hunk" command.
@@ -87,4 +91,4 @@ Magit
 -----
 
 If you have a recent enough version installed, it defines
-`magit-revert-buffer-hook`, which we use.
+`magit-revert-buffer-hook` (or `magit-not-reverted-hook`), which we use.