summaryrefslogtreecommitdiff
path: root/plugins/aliases/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/aliases/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/aliases/README.md')
-rw-r--r--plugins/aliases/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/plugins/aliases/README.md b/plugins/aliases/README.md
new file mode 100644
index 000000000..481c1bd4e
--- /dev/null
+++ b/plugins/aliases/README.md
@@ -0,0 +1,21 @@
+## Aliases Cheatsheet
+
+**Maintainer:** [@hqingyi](https://github.com/hqingyi)
+
+With lots of 3rd-party amazing aliases installed, this plugin helps list the shortcuts
+that are currently available based on the plugins you have enabled.
+
+Enable this plugin by adding it to your `plugins` definition in `~/.zshrc`.
+
+ ```
+ plugins=(aliases)
+ ```
+
+Requirements: Python needs to be installed.
+
+### Usage
+
+```
+ acs: group all alias
+ acs $keywordquickly filter alias & highlight
+```