branch: master
commit 15580640b3078405455faf0228a13eed3212f188
Author: Dmitry Gutov <[email protected]>
Commit: Dmitry Gutov <[email protected]>
Reword the recent README changes
---
README.md | 7 ++++++-
1 files changed, 6 insertions(+), 1 deletions(-)
diff --git a/README.md b/README.md
index 20274bb..ab8c9d8 100644
--- 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
use the margin instead of the fringe.
* `diff-hl-amend-mode` shifts the reference revision back by one.
-* `diff-hl-flydiff-mode` enables diffing unsaved changes
+* `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.
@@ -47,6 +48,10 @@ Emacs 24+. On OS X, Emacs 24.3 or higher is recommended.
Notes
=====
+* 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
rarely a significant problem, since if you're using such a mode,
