-
David O'Trakoun
committed
8 years ago
Revision indexing in progress... (symbol navigation in revisions will be accurate after indexed)
-
skipped 21 lines 22 22 23 23 ### Installation 24 24 25 + #### Without using a framework 26 + 27 + The preferred way of installation is to simply add the `git-open` script 28 + somewhere into your path (e.g. add the directory to your `PATH` environment 29 + or copy `git-open` into an existing included path like `/usr/local/bin`). 30 + 31 + You can use also `npm` to install an OLD (1 year ago) version of this package: 32 + 25 33 npm install --global git-open 26 34 27 - ### Supported hosts 35 + #### Using a ZSH Framework 28 36 29 - * <github.com> 30 - * <gist.github.com> 31 - * <gitlab.com> 32 - * Gitlab custom hosted (see below) 33 - * <bitbucket.org> 34 - * Atlassian Stash 37 + ##### [Antigen](https://github.com/zsh-users/antigen) 38 + 39 + Add `antigen bundle paulirish/git-open` to your `.zshrc` with your other bundle 40 + commands. 41 + 42 + Antigen will handle cloning the plugin for you automatically the next time you 43 + start zsh, and periodically checking for updates to the git repository. You can 44 + also add the plugin to a running zsh with `antigen bundle paulirish/git-open` 45 + for testing before adding it to your `.zshrc`. 46 + 47 + ##### [Oh-My-Zsh](http://ohmyz.sh/) 48 + 49 + 1. `cd ~/.oh-my-zsh/custom/plugins` 50 + 1. `git clone [email protected]:paulirish/git-open.git gitopen` 51 + 1. Add git-open to your plugin list - edit `~/.zshrc` and change 52 + `plugins=(...)` to `plugins=(... gitopen)` 53 + 54 + ##### [Zgen](https://github.com/tarjoilija/zgen) 55 + Add `zgen load paulirish/git-open` to your .zshrc file in the same function 56 + you're doing your other `zgen load` calls in. ZGen will take care of cloning 57 + the repository the next time you run `zgen save`, and will also periodically 58 + check for updates to the git repository. 59 + 60 + ##### [zplug](https://github.com/zplug/zplug) 61 + 62 + `zplug "paulirish/git-open", as:command` 63 + 64 + ### Supported remote repositories 65 + 66 + git-open can automatically guess the corresponding repository page for remotes 67 + (default looks for `origin`) on the following hosts: 68 + 69 + - github.com 70 + - gist.github.com 71 + - gitlab.com 72 + - Gitlab custom hosted (see below) 73 + - bitbucket.org 74 + - Atlassian Stash 35 75 36 76 #### Gitlab support 37 77 38 - To configure gitlab support you need to set `gitopen.gitlab.domain` 78 + To configure gitlab support globally you need to set `gitopen.gitlab.domain` 39 79 40 80 git config --global gitopen.gitlab.domain [yourdomain.here] 41 81 42 - or 82 + or in your local repository: 43 83 44 - git config gitopen.gitlab.domain [yourdomain.here] # in your local repository 84 + git config gitopen.gitlab.domain [yourdomain.here] 45 85 46 - ## Related projects 86 + ## Related projects / alternatives 47 87 48 88 See [hub](https://github.com/github/hub) for complete GitHub opening support. 49 89 It's the official GitHub project and provides `hub browse`. 50 90 91 + Homebrew has an alternate [git-open](https://github.com/jeffreyiacono/git-open) 92 + that only works with GitHub but can open user profile pages, too. 93 + 51 94 ## Thanks 52 95 53 96 [jasonmccreary](https://github.com/jasonmccreary/) did skipped 2 lines 56 99 See the contributors tab for a growing list of people who have submitted PRs. 57 100 58 101 ## Contributing 59 - 60 102 Please provide examples of the URLs you are parsing with each PR. 61 103 62 104 ## License skipped 1 lines 64 106 Copyright Jason McCreary & Paul Irish. Licensed under MIT. 65 107 http://opensource.org/licenses/MIT 66 108 109 + ## Changelog 110 + 111 + - **2016-07-11** - Changelog started (readme formatting and installation 112 + instructions updated) 113 + 114 +