From 579cd7cc89bd7b32efde273410d3bb878f933ee3 Mon Sep 17 00:00:00 2001 From: David O'Trakoun Date: Mon, 11 Jul 2016 19:25:06 -0400 Subject: [PATCH] readme additions and formatting --- README.md | 60 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 35 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 567bfb5..c192770 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,14 @@ # git-open -Type `git open` to open the GitHub page or website for a repository in your browser. +Type `git open` to open the GitHub page or website for a repository in your +browser. ## Usage + git open [remote-name] [branch-name] -![git open2015-01-24 13_51_18](https://cloud.githubusercontent.com/assets/39191/5889192/244a0b72-a3d0-11e4-8ab9-55fc64228aaa.gif) - ### Examples + $ git open > open https://github.com/REMOTE_ORIGIN_USER/CURRENT_REPO/tree/CURRENT_BRANCH @@ -17,39 +18,48 @@ Type `git open` to open the GitHub page or website for a repository in your brow $ git open upstream master > open https://github.com/REMOTE_UPSTREAM_USER/CURRENT_REPO/tree/master +![git open2015-01-24 13_51_18](https://cloud.githubusercontent.com/assets/39191/5889192/244a0b72-a3d0-11e4-8ab9-55fc64228aaa.gif) -## Installation +### Installation + npm install --global git-open -```sh -npm install --global git-open -``` +### Supported hosts - -#### Supported: -* Github.com -* Gists on Github -* Bitbucket -* Atlassian Stash -* Gitlab.com +* +* +* * Gitlab custom hosted (see below) +* +* Atlassian Stash +#### Gitlab support -## Gitlab support -To configure gitlab support you need to set gitopen.gitlab.domain: +To configure gitlab support you need to set `gitopen.gitlab.domain` -``` -git config --global gitopen.gitlab.domain [yourdomain.here] -# or -git config gitopen.gitlab.domain [yourdomain.here] # in your local repository -``` + git config --global gitopen.gitlab.domain [yourdomain.here] +or -## Thx -@jasonmccreary did [all the hard work](https://github.com/jasonmccreary/gh) + git config gitopen.gitlab.domain [yourdomain.here] # in your local repository + +## Related projects + +See [hub](https://github.com/github/hub) for complete GitHub opening support. +It's the official GitHub project and provides `hub browse`. + +## Thanks + +[jasonmccreary](https://github.com/jasonmccreary/) did +[all the hard work](https://github.com/jasonmccreary/gh) + +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. - +Copyright Jason McCreary & Paul Irish. Licensed under MIT. http://opensource.org/licenses/MIT