浏览代码

Fix formatting and usage section

Also:

- Changes `globes` (which doesn't exist) to `glob expressions`.

- Delete the `trigger autocompletion to your current aliases` use case, since that's not
  really implemented.
Marc Cornellà 8 年之前
父节点
当前提交
f701b4de0f
共有 1 个文件被更改,包括 40 次插入15 次删除
  1. 40 15
      plugins/globalias/README.md

+ 40 - 15
plugins/globalias/README.md

@@ -1,37 +1,62 @@
-#Globalias
+# Globalias plugin
 
+Expands all glob expressions, subcommands and aliases (including global).
 
-Expands all globes, backtick expressions and aliases(including global).
+Idea from: http://blog.patshead.com/2012/11/automatically-expaning-zsh-global-aliases---simplified.html.
+
+## Usage
+
+Add `globalias` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... globalias)
+```
+
+Then just press `SPACE` to trigger the expansion of a command you've written.
+
+If you only want to insert a space without expanding the command line, press
+`CTRL`+`SPACE`.
+
+## Examples
+
+#### Glob expressions
 
 ```
 $ touch {1..10}<space>
-#expands to
+# expands to
 $ touch 1 2 3 4 5 6 7 8 9 10
 
+$ ls **/*.json<space>
+# expands to
+$ ls folder/file.json anotherfolder/another.json
+```
+
+#### Subcommands
+
+```
 $ mkdir "`date -R`"
-#expands to
+# expands to
 $ mkdir Tue,\ 04\ Oct\ 2016\ 13:54:03\ +0300
 
-#.zshrc:
+```
+
+#### Aliases
+
+```
+# .zshrc:
 alias -g G="| grep --color=auto -P"
 alias l='ls --color=auto -lah'
 
 $ l<space>G<space>
-#expands to
+# expands to
 $ ls --color=auto -lah | grep --color=auto -P
-
-ls **/*.json<space>
-#expands to
-ls folder/file.json anotherfolder/another.json
 ```
 
-####Returns autocompletion to your custom aliases:
 ```
-#.zsrc
+# .zsrc:
 alias S="sudo systemctl"
 
 $ S<space>
-#expands to:
-sudo systemctl s<tab>
-#trigger autocompletion
+# expands to:
+$ sudo systemctl
 ```