[elpa] scratch/add-vdiff 9a748df 065/258: Update README

[Justin Burkett]

branch: scratch/add-vdiff
commit 9a748dfb8ebecdcad9b8c7199bd4da38bbca0d12
Author: justbur <address@hidden>
Commit: justbur <address@hidden>

    Update README
    
    Fixes #3
---
 README.org | 30 ++++++++++++++----------------
 1 file changed, 14 insertions(+), 16 deletions(-)

diff --git a/README.org b/README.org
index d4b2b77..f407a8f 100644
--- a/README.org
+++ b/README.org
@@ -7,22 +7,17 @@ A tool like vimdiff for Emacs
 vdiff is a diff tool for Emacs that is made to behave like vimdiff, meaning 
diff
 information is displayed in buffers as you edit them. There are commands for
 cycling through the changes detected by =diff= and applying changes from one
-buffer to the other. 
-
-ediff is a powerful diff tool built into Emacs, but it works differently. In
-ediff you control the diffed buffers through a third control buffer, which 
works
-great until you want to edit the buffers directly. I prefer the way vimdiff
-works, but I am also not necessarily interested in perfectly emulating
-vimdiff. vdiff does not assume you use evil-mode, but is compatible with it.
-
-vdiff is a work in progress, so use it at your own risk. Contributions and
-suggestions are very welcome. A rough TODO list is
-
-1. Improve scrolling/syncing position between buffers
-2. Three way diffs
-3. Other missing features from vimdiff
-4. Add tests
-5. Improve faces
+buffer to the other. The main features are
+
+  1. Synchronized scrolling of the buffers with lines matching between the two
+  2. Commands to transmit (send/receive) changes between buffers
+  3. Automatic folding of lines that are unchanged in both buffers
+  4. Commands to jump easily between changes
+  5. Everything done through overlays, meaning vdiff doesn't alter the actual
+     text in the buffer (unless you are transmit changes of course)
+
+vdiff is still a work in progress, so use it at your own risk. Contributions 
and
+suggestions are very welcome.
    
 ** Screenshot
 
@@ -90,6 +85,9 @@ The current customization options and there defaults are
   ;; Unchanged lines to leave unfolded around a fold
   (setq vdiff-fold-padding 2)
 
+  ;; Minimum number of lines to fold
+  (setq vdiff-min-fold-size 4)
+
   ;; Function that returns the string printed for a closed fold. The arguments
   ;; passed are the number of lines folded, the text on the first line, and the
   ;; width of the buffer.