Skip to content

Commit

Permalink
update readme instructions for zsh users
Browse files Browse the repository at this point in the history
  • Loading branch information
dsifford committed Apr 20, 2017
1 parent 5e673d9 commit 39d08ff
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,25 @@

> Shell autocompletion for [Yarn](https://github.com/yarnpkg/yarn)
**Note:** bash is currently the only supported shell.
## Installation

## Usage
1. Download the completion file to your machine.

See comment at the top of the file.
```sh
$ curl -o ~/.yarn-completion https://raw.githubusercontent.com/dsifford/yarn-completion/master/yarn-completion.bash
```

2. Source the file in your shell `rc` file.

**`bash`**
```sh
$ echo -e '\n. ~/.yarn-completion' >> ~/.bashrc
```

**`zsh`**
```sh
$ echo -e '\nautoload -U bashcompinit && bashcompinit\n. ~/.yarn-completion' >> ~/.zshrc
```

## License

Expand Down

0 comments on commit 39d08ff

Please sign in to comment.