diff --git a/README.md b/README.md index c192770..7130851 100644 --- a/README.md +++ b/README.md @@ -22,32 +22,75 @@ browser. ### Installation +#### Without using a framework + +The preferred way of installation is to simply add the `git-open` script +somewhere into your path (e.g. add the directory to your `PATH` environment +or copy `git-open` into an existing included path like `/usr/local/bin`). + +You can use also `npm` to install an OLD (1 year ago) version of this package: + npm install --global git-open -### Supported hosts +#### Using a ZSH Framework -* -* -* -* Gitlab custom hosted (see below) -* -* Atlassian Stash +##### [Antigen](https://github.com/zsh-users/antigen) + +Add `antigen bundle paulirish/git-open` to your `.zshrc` with your other bundle +commands. + +Antigen will handle cloning the plugin for you automatically the next time you +start zsh, and periodically checking for updates to the git repository. You can +also add the plugin to a running zsh with `antigen bundle paulirish/git-open` +for testing before adding it to your `.zshrc`. + +##### [Oh-My-Zsh](http://ohmyz.sh/) + +1. `cd ~/.oh-my-zsh/custom/plugins` +1. `git clone git@github.com:paulirish/git-open.git gitopen` +1. Add git-open to your plugin list - edit `~/.zshrc` and change + `plugins=(...)` to `plugins=(... gitopen)` + +##### [Zgen](https://github.com/tarjoilija/zgen) +Add `zgen load paulirish/git-open` to your .zshrc file in the same function +you're doing your other `zgen load` calls in. ZGen will take care of cloning +the repository the next time you run `zgen save`, and will also periodically +check for updates to the git repository. + +##### [zplug](https://github.com/zplug/zplug) + +`zplug "paulirish/git-open", as:command` + +### Supported remote repositories + +git-open can automatically guess the corresponding repository page for remotes +(default looks for `origin`) on the following hosts: + +- github.com +- gist.github.com +- gitlab.com +- Gitlab custom hosted (see below) +- bitbucket.org +- Atlassian Stash #### Gitlab support -To configure gitlab support you need to set `gitopen.gitlab.domain` +To configure gitlab support globally you need to set `gitopen.gitlab.domain` git config --global gitopen.gitlab.domain [yourdomain.here] -or +or in your local repository: - git config gitopen.gitlab.domain [yourdomain.here] # in your local repository + git config gitopen.gitlab.domain [yourdomain.here] -## Related projects +## Related projects / alternatives See [hub](https://github.com/github/hub) for complete GitHub opening support. It's the official GitHub project and provides `hub browse`. +Homebrew has an alternate [git-open](https://github.com/jeffreyiacono/git-open) +that only works with GitHub but can open user profile pages, too. + ## Thanks [jasonmccreary](https://github.com/jasonmccreary/) did @@ -56,10 +99,15 @@ It's the official GitHub project and provides `hub browse`. See the contributors tab for a growing list of people who have submitted PRs. ## Contributing - Please provide examples of the URLs you are parsing with each PR. ## License Copyright Jason McCreary & Paul Irish. Licensed under MIT. http://opensource.org/licenses/MIT + +## Changelog + +- **2016-07-11** - Changelog started (readme formatting and installation + instructions updated) + diff --git a/git-open.plugin.zsh b/git-open.plugin.zsh new file mode 100644 index 0000000..49fbb9f --- /dev/null +++ b/git-open.plugin.zsh @@ -0,0 +1,6 @@ +# This plugin is MIT licensed to match the git-open license. +# +# Make git-open easy to install and keep up to date if you're using a +# ZSH framework like Zgen or Antigen + + export PATH=$(dirname $0):${PATH}