Merge pull request #50 from PythonNut/master

[gnu-emacs-elpa] / README.md

diff --git a/README.md b/README.md
index b01e8bd206cd6c71b26400cf1732d39d3847a194..20274bbc122269dda6bc33fc5c0c779c8c77229b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -15,6 +15,7 @@ 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
 \r
 Check out the Commentary section in each respective file for the usage\r
 instructions.\r
@@ -46,25 +47,24 @@ 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
-\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
   you'd usually want to fix all errors and warnings before continuing,\r
   and then the conflicting indicators go away.\r
 \r
-* There's no fringe when Emacs is running in the console, but the navigation and\r
-  revert commands still work. Consider turning `diff-hl-margin-mode` on.\r
+* There's no fringe when Emacs is running in the console, but the navigation\r
+  and revert commands still work. Consider turning `diff-hl-margin-mode` on,\r
+  to show the indicators in the margin instead.\r
 \r
 * Frame-local and buffer-local values of `line-spacing` are not supported.\r
 \r
-* [git-gutter](https://github.com/syohex/emacs-git-gutter) provides interactive\r
-  commands to show/hide/toggle margin indicators for the same information, and\r
-  allows you to customize how the indicators look.\r
+* Fringe width up to 16 works best (because we can't define a bitmap\r
+  with width above that number).\r
+\r
+* [emacs-git-gutter](https://github.com/syohex/emacs-git-gutter) shows\r
+  indicators in the margin by default, allows you to customize how the\r
+  indicators look more easily, and has a "stage hunk" command.\r
 \r
 Integration\r
 =====\r
@@ -81,3 +81,9 @@ psvn
 (defadvice svn-status-update-modeline (after svn-update-diff-hl activate)\r
   (diff-hl-update))\r
 ```\r
+\r
+Magit\r
+-----\r
+\r
+If you have a recent enough version installed, it defines\r
+`magit-revert-buffer-hook` (or `magit-not-reverted-hook`), which we use.\r