branch: externals/dired-git-info
commit 6ec44d72698e9f293f2af7315a27c1f2e5c16dd0
Author: Ma'or Kadosh <4103412+it-is-wednes...@users.noreply.github.com>
Commit: GitHub <nore...@github.com>
extend config info in readme
---
README.org | 29 ++++++++++++++++++++++++++++-
1 file changed, 28 insertions(+), 1 deletion(-)
diff --git a/README.org b/README.org
index c34f9c9..b79f025 100644
--- a/README.org
+++ b/README.org
@@ -11,6 +11,12 @@ the dired buffer:
* Installation
+** MELPA
+
+[[https://melpa.org/#/getting-started][Set up MELPA]], then install via =M-x
package-install RET dired-git-info=
+
+** Manual
+
For manual installation, clone the repository and call:
#+BEGIN_SRC elisp
@@ -19,9 +25,30 @@ For manual installation, clone the repository and call:
* Config
-Bind the minor mode command in dired:
+** Bind the minor mode command in dired
#+BEGIN_SRC elisp
(with-eval-after-load 'dired
(define-key dired-mode-map ")" 'dired-git-info-mode))
#+END_SRC
+
+** Don't hide normal Dired file info
+
+By default, toggling =dired-git-info-mode= also toggles the built-in
=dired-hide-details-mode=, which hides file details such as ownership,
permissions and size. This behaviour can be disabled by overriding
=dgi-auto-hide-details-p=:
+
+#+BEGIN_SRC elisp
+(with-eval-after-load 'dired
+ (setq dgi-auto-hide-details-p nil))
+#+END_SRC
+
+** Enable automatically in every Dired buffer (if in Git repository)
+
+To enable =dired-git-info-mode= whenever you navigate to a Git repository, add
the following snippet:
+#+BEGIN_SRC elisp
+(with-eval-after-load 'dired
+ (defun dired-git-info-mode-loose ()
+ "enable 'dired-git-info-mode only if current Dired buffer is in a Git repo"
+ (if (locate-dominating-file "." ".git")
+ (dired-git-info-mode)))
+ (add-hook 'dired-after-readin-hook 'dired-git-info-mode-loose))
+#+END_SRC
