From 25fcf0c265c682f092ce49a6849e5e09b38dffa9 Mon Sep 17 00:00:00 2001
From: slavaGanzin <slava.ganzin@gmail.com>
Date: Tue, 4 Oct 2016 21:26:19 +0300
Subject: git-auto-fetch: README.md

---
 plugins/git-auto-fetch/README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 plugins/git-auto-fetch/README.md

(limited to 'plugins/git-auto-fetch/README.md')

diff --git a/plugins/git-auto-fetch/README.md b/plugins/git-auto-fetch/README.md
new file mode 100644
index 000000000..7f5eac49d
--- /dev/null
+++ b/plugins/git-auto-fetch/README.md
@@ -0,0 +1,22 @@
+# Git auto fetch
+
+Automatically fetches all changes from all remotes every time you cd into yout git-initialized project.
+
+####Usage
+Add ```git-auto-fetch``` to the plugins array in your zshrc file:
+```shell
+plugins=(... git-auto-fetch)
+```
+
+Every time you change directory to your git project all remotes will be fetched in background. Log of ```git fetch --all``` will be saved into .git/FETCH_LOG
+
+####Toggle auto fetch per folder
+If you are using mobile connection or for any other reason you can disable git-auto-fetch for any folder:
+
+```shell
+$ cd to/your/project
+$ git-auto-fetch
+disabled
+$ git-auto-fetch
+enabled
+```
-- 
cgit v1.2.3-70-g09d2