summaryrefslogtreecommitdiff
path: root/plugins/zoxide/README.md
diff options
context:
space:
mode:
authorAjeet D'Souza <98ajeet@gmail.com>2021-06-13 23:00:58 +0530
committerGitHub <noreply@github.com>2021-06-13 10:30:58 -0700
commit36cc94f3dcd8d6214b5a4bedf180bc723eb49a3f (patch)
tree7589409fa26bf683d42c051797ae3204dd229e64 /plugins/zoxide/README.md
parent3ea66642e8d86b597e6c789358b82540859b178a (diff)
downloadzsh-36cc94f3dcd8d6214b5a4bedf180bc723eb49a3f.tar.gz
zsh-36cc94f3dcd8d6214b5a4bedf180bc723eb49a3f.tar.bz2
zsh-36cc94f3dcd8d6214b5a4bedf180bc723eb49a3f.zip
feat(zoxide): add new plugin for zoxide (a smarter cd CLI tool) (#9950)
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.