56de7c85f34a15a4490f4984e128dba78fcebfd3

Author
Cédric Malard <c.malard-git@valdun.net>
Committer
GitHub <noreply@github.com>
Date

Message

docs(aliases): clarify usage (#9990)

Diff

 1diff --git a/plugins/aliases/README.md b/plugins/aliases/README.md
 2index 481c1bd4e87156eed4316db8edfb5b34ea6c14df..bfb6ab8c47b0f233600d853078836e48ba10094d 100644
 3--- a/plugins/aliases/README.md
 4+++ b/plugins/aliases/README.md
 5@@ -1,21 +1,22 @@
 6-## Aliases Cheatsheet
 7+# Aliases cheatsheet
 8 
 9 **Maintainer:** [@hqingyi](https://github.com/hqingyi)
10 
11 With lots of 3rd-party amazing aliases installed, this plugin helps list the shortcuts
12 that are currently available based on the plugins you have enabled.
13 
14-Enable this plugin by adding it to your `plugins` definition in `~/.zshrc`.
15+To use it, add `aliases` to the plugins array in your zshrc file:
16 
17-  ```
18-  plugins=(aliases)
19-  ```
20+```zsh
21+plugins=(aliases)
22+```
23 
24 Requirements: Python needs to be installed.
25 
26-### Usage
27+## Usage
28 
29-```
30-  acs: group all alias
31-  acs $keywordquickly filter alias & highlight
32-```
33+- `acs`: show all aliases by group.
34+
35+- `acs <keyword>`: filter aliases by `<keyword>` and highlight.
36+
37+  ![screenshot](https://cloud.githubusercontent.com/assets/3602957/11581913/cb54fb8a-9a82-11e5-846b-5a67f67ad9ad.png)