summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobby Russell <robby@planetargon.com>2021-06-11 19:43:24 -0700
committerRobby Russell <robby@planetargon.com>2021-06-11 19:46:00 -0700
commit5cdba87025b9dca3c6f2378a58595c613464fc63 (patch)
tree50f4c0a4b58824a08fc92e55d80a6dea432d0a61
parente47a8e2321be9e7af49872588619c031a757d6ea (diff)
downloadzsh-5cdba87025b9dca3c6f2378a58595c613464fc63.tar.gz
zsh-5cdba87025b9dca3c6f2378a58595c613464fc63.tar.bz2
zsh-5cdba87025b9dca3c6f2378a58595c613464fc63.zip
Aliases: Adding a README file for the plugin. #4662
-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
+```