summaryrefslogtreecommitdiff
path: root/plugins/zoxide/README.md
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2021-07-11 19:58:51 -0600
committerTuowen Zhao <ztuowen@gmail.com>2021-07-11 19:58:51 -0600
commit617ed3bd9f3d9519fe2354941f3dbf15b0c712ee (patch)
treecaf617b35d3f5f7b5786483eedfcda9361dca108 /plugins/zoxide/README.md
parent0144641b7d8e4e6ff6ce153039b5a827f5347904 (diff)
parent36f444ed7325720ec05f182781ec7d6c9a4d675c (diff)
downloadzsh-617ed3bd9f3d9519fe2354941f3dbf15b0c712ee.tar.gz
zsh-617ed3bd9f3d9519fe2354941f3dbf15b0c712ee.tar.bz2
zsh-617ed3bd9f3d9519fe2354941f3dbf15b0c712ee.zip
Merge remote-tracking branch 'origin/master'
Diffstat (limited to 'plugins/zoxide/README.md')
-rw-r--r--plugins/zoxide/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/plugins/zoxide/README.md b/plugins/zoxide/README.md
new file mode 100644
index 000000000..f326effe6
--- /dev/null
+++ b/plugins/zoxide/README.md
@@ -0,0 +1,14 @@
+# zoxide plugin
+
+Initializes [zoxide](https://github.com/ajeetdsouza/zoxide), a smarter cd
+command for your terminal.
+
+![Tutorial](https://raw.githubusercontent.com/ajeetdsouza/zoxide/97dc08347d9dbf5b5a4516b79e0ac27366b962ce/contrib/tutorial.webp)
+
+To use it, add `zoxide` to the plugins array in your `.zshrc` file:
+
+```zsh
+plugins=(... zoxide)
+```
+
+**Note:** you have to [install zoxide](https://github.com/ajeetdsouza/zoxide#step-1-install-zoxide) first.