diff options
Diffstat (limited to 'plugins/github')
| -rw-r--r-- | plugins/github/README.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/plugins/github/README.md b/plugins/github/README.md index 2b66e390f..70b863f64 100644 --- a/plugins/github/README.md +++ b/plugins/github/README.md @@ -1,4 +1,4 @@ -# github +# github plugin This plugin supports working with GitHub from the command line. It provides a few things: @@ -6,7 +6,7 @@ This plugin supports working with GitHub from the command line. It provides a fe * Completion for the `github` Ruby gem. * Convenience functions for working with repos and URLs. -### Functions +### Functions * `empty_gh` - Creates a new empty repo (with a `README.md`) and pushes it to GitHub * `new_gh` - Initializes an existing directory as a repo and pushes it to GitHub @@ -14,13 +14,13 @@ This plugin supports working with GitHub from the command line. It provides a fe * `git.io` - Shortens a URL using [git.io](https://git.io) -## Installation +## Installation [Hub](https://github.com/github/hub) needs to be installed if you want to use it. On OS X with Homebrew, this can be done with `brew install hub`. The `hub` completion definition needs to be added to your `$FPATH` before initializing OMZ. The [`github` Ruby gem](https://github.com/defunkt/github-gem) needs to be installed if you want to use it. -### Configuration +### Configuration These settings affect `github`'s behavior. @@ -35,7 +35,7 @@ These settings affect `github`'s behavior. See `man hub` for more details. -### Homebrew installation note +### Homebrew installation note If you have installed `hub` using Homebrew, its completions may not be on your `$FPATH` if you are using the system `zsh`. Homebrew installs `zsh` completion definitions to `/usr/local/share/zsh/site-functions`, which will be on `$FPATH` for the Homebrew-installed `zsh`, but not for the system `zsh`. If you want it to work with the system `zsh`, add this to your `~/.zshrc` before it sources `oh-my-zsh.sh`. |