Merge pull request #238 from cdayjr/easier-zsh-completion-install

completion/README.md

@@ -1,36 +1,50 @@
 # Installation
 
 ## Bash completions
+
 ### Prerequisites
+
 **yadm** completion only works if Git completions are also enabled.
 
 ### Homebrew
-If using `homebrew` to install **yadm**, completions should automatically be handled if you also install `brew install bash-completion`. This might require you to include the main completion script in your own bashrc file like this:
-```
+
+If using `homebrew` to install **yadm**, completions should automatically be
+handled if you also install `brew install bash-completion`. This might require
+you to include the main completion script in your own bashrc file like this:
+
+```bash
 [ -f /usr/local/etc/bash_completion ] && source /usr/local/etc/bash_completion
 ```
 
 ### Manual installation
+
 Copy the completion script locally, and add this to you bashrc:
-```
+
+```bash
 [ -f /full/path/to/yadm.bash_completion ] && source /full/path/to/yadm.bash_completion
 ```
 
 ## Zsh completions
+
 ### Homebrew
+
 If using `homebrew` to install **yadm**, completions should handled automatically.
 
 ### Manual installation
-Copy the completion script `yadm.zsh_completion` locally, rename it to `_yadm`, and add the containing folder to `$fpath` in `.zshrc`:
-```
-fpath=(/path/to/folder/containing_yadm $fpath)
+
+Add the `completion/zsh` folder to `$fpath` in `.zshrc`:
+
+```zsh
+fpath=(/full/path/to/yadm/completion/zsh $fpath)
 autoload -U compinit
 compinit
 ```
 
 ### Installation using [zplug](https://github.com/b4b4r07/zplug)
+
 Load `_yadm` as a plugin in your `.zshrc`:
-```
+
+```zsh
 fpath=("$ZPLUG_HOME/bin" $fpath)
 zplug "TheLocehiliosan/yadm", rename-to:_yadm, use:"completion/yadm.zsh_completion", as:command, defer:2
 ```

completion/zsh/_yadm

@@ -0,0 +1 @@
+yadm.zsh_completion