[elpa] scratch/add-vdiff 3a32c4e 255/258: README: Update

[Justin Burkett]

branch: scratch/add-vdiff
commit 3a32c4e1e29d4c6e59e381e61db00c65dbe40c55
Author: Justin Burkett <address@hidden>
Commit: Justin Burkett <address@hidden>

    README: Update
---
 README.org | 20 ++++++++++++++++----
 1 file changed, 16 insertions(+), 4 deletions(-)

diff --git a/README.org b/README.org
index 16c1a6e..8fc21a2 100644
--- a/README.org
+++ b/README.org
@@ -163,10 +163,7 @@ map. Bind =vdiff-hydra/body= directly to customize this 
key binding.
 Loading =vdiff-magit= will pull in functions that will allow vdiff to be used
 with [[https://github.com/magit/magit][magit]]. In order to use these 
functions you need to call the vdiff functions
 instead of the magit-ediff ones. Here is a very basic setup which replaces the
-basic ediff key bindings in magit. 
-
-Please note that this is a new feature and probably contains some bugs, so use
-it with caution and please report oddities. 
+basic ediff key bindings in magit.
 
 #+BEGIN_SRC emacs-lisp
   (require 'vdiff-magit)
@@ -180,8 +177,23 @@ it with caution and please report oddities.
   ;; support 3-way merges. Please see the docstring of this variable for more
   ;; information
   ;; (setq vdiff-magit-use-ediff-for-merges nil)
+
+  ;; Whether vdiff-magit-dwim runs show variants on hunks.  If non-nil,
+  ;; vdiff-magit-show-staged or vdiff-magit-show-unstaged are called based on 
what
+  ;; section the hunk is in.  Otherwise, vdiff-magit-dwim runs 
vdiff-magit-stage
+  ;; when point is on an uncommitted hunk.
+  ;; (setq vdiff-magit-dwim-show-on-hunks nil)
+
+  ;; Whether vdiff-magit-show-stash shows the state of the index.
+  ;; (setq vdiff-magit-show-stash-with-index t)
+
+  ;; Only use two buffers (working file and index) for vdiff-magit-stage
+  ;; (setq vdiff-magit-stage-is-2way nil)
 #+END_SRC
 
+Please note that this is a new feature and probably contains some bugs, so use
+it with caution and please report oddities.
+
 ** Further customization
    
 The current customization options and there defaults are