summaryrefslogtreecommitdiff
path: root/plugins/dirpersist
diff options
context:
space:
mode:
authorJeffrey Chandler <36927673+jeff-chandler@users.noreply.github.com>2018-10-14 12:39:14 -0400
committerRobby Russell <robby@planetargon.com>2018-10-14 09:39:14 -0700
commit010ecf4f931b9c8c7b3ea5b27d1b51bf7f00f30a (patch)
treedcd5a087a3beba8f0b601c069718f83aa4d678a1 /plugins/dirpersist
parent8db85db3cf5741fed1f03be8e7a0d5e044c175e8 (diff)
downloadzsh-010ecf4f931b9c8c7b3ea5b27d1b51bf7f00f30a.tar.gz
zsh-010ecf4f931b9c8c7b3ea5b27d1b51bf7f00f30a.tar.bz2
zsh-010ecf4f931b9c8c7b3ea5b27d1b51bf7f00f30a.zip
Added README file to the dirpersist plugin (#7274)
* Added README file to the dirpersist plugin added additional details on how the plugin works.
Diffstat (limited to 'plugins/dirpersist')
-rw-r--r--plugins/dirpersist/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/plugins/dirpersist/README.md b/plugins/dirpersist/README.md
new file mode 100644
index 000000000..9880bc563
--- /dev/null
+++ b/plugins/dirpersist/README.md
@@ -0,0 +1,9 @@
+# Dirpersist plugin
+
+This plugin keeps a running tally of the previous 20 unique directories in the $HOME/.zdirs file. When you cd to a new directory, it is prepended to the beginning of the file.
+
+To use it, add `dirpersist` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... dirpersist)
+```