X-Git-Url: https://code.delx.au/gnu-emacs-elpa/blobdiff_plain/2d75ef18b1d38d39e6bba7afd4cc80dd6037cd9e..06e551bd5ecd996621bb267297ef4644c7221207:/README.md

diff --git a/README.md b/README.md
index 6e82c3ad0..ab8c9d81e 100644
--- a/README.md
+++ b/README.md
@@ -1,26 +1,94 @@
 About
 =====
 
-`diff-hl-mode` provides IDE-like highlighting on the fringe to the left of the
-changed buffer lines, compared to current HEAD.
+`diff-hl-mode` highlights uncommitted changes on the left side of the window,
+allows you to jump between and revert them selectively.
 
-Since it uses the corresponding VC diff command, it's only accurate when a
-buffer is in saved state.
+For the usage instructions and the list of commands, see the Commentary section
+inside the file.
 
-Tested with Git, Mercurial, and Bazaar. May work with other VC backends, too.
+Tested with Git, Mercurial, Bazaar and SVN. May work with other VC backends, too.
 
-Usage
+The package also contains auxiliary modes:
+
+* `diff-hl-dired-mode` provides similar functionality in Dired.
+* `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.
+
+Screenshots
+=====
+
+diff-hl-mode
+-----
+Top window: a buffer in this minor mode, bottom window: the corresponding diff.
+
+![screenie](screenshot.png)
+
+diff-hl-dired-mode
+-----
+
+![screenie](screenshot-dired.png)
+
+diff-hl-margin-mode
+-----
+
+![screenie](screenshot-margin.png)
+
+Requirements
 =====
 
-Ensure diff-hl.el is in a directory on your load-path, and add the following to
-your `~/.emacs` or `~/.emacs.d/init.el`
+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,
+  you'd usually want to fix all errors and warnings before continuing,
+  and then the conflicting indicators go away.
+
+* There's no fringe when Emacs is running in the console, but the navigation
+  and revert commands still work. Consider turning `diff-hl-margin-mode` on,
+  to show the indicators in the margin instead.
+
+* 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.
+
+Integration
+=====
 
-    (require 'diff-hl)
+If you're using some package other than `vc` to commit changes, it might
+not run `vc-checkin-hook` after commits. In that case, you'll need to
+either add `diff-hl-update` to the hook it does run, or advise some
+function that's called in the buffer after its state has changed.
 
-and, to use it in all buffers
+psvn
+-----
 
-    (global-diff-hl-mode)
+```lisp
+(defadvice svn-status-update-modeline (after svn-update-diff-hl activate)
+  (diff-hl-update))
+```
 
-or, for example, to use it in all `prog-mode` buffers
+Magit
+-----
 
-    (add-hook 'prog-mode-hook 'turn-on-diff-hl-mode)
+If you have a recent enough version installed, it defines
+`magit-revert-buffer-hook` (or `magit-not-reverted-hook`), which we use.