STRLCPY/git-open

readme additions and formatting
David O'Trakoun committed 8 years ago

579cd7cc

1 parent 55a5b96a

Total 1 files

■ ■ ■ ■ ■ ■

README.md

1	1		# git-open
2	2
3		-	Type `git open` to open the GitHub page or website for a repository in your browser.
	3	+	Type `git open` to open the GitHub page or website for a repository in your
	4	+	browser.
4	5
5	6		## Usage
6		-	git open [remote-name] [branch-name]
7	7
8		-	![git open2015-01-24 13_51_18](https://cloud.githubusercontent.com/assets/39191/5889192/244a0b72-a3d0-11e4-8ab9-55fc64228aaa.gif)
	8	+	git open [remote-name] [branch-name]
9	9
10	10		### Examples
	11	+
11	12		$ git open
12	13		> open https://github.com/REMOTE_ORIGIN_USER/CURRENT_REPO/tree/CURRENT_BRANCH
13	14
		skipped 3 lines
17	18		$ git open upstream master
18	19		> open https://github.com/REMOTE_UPSTREAM_USER/CURRENT_REPO/tree/master
19	20
	21	+	![git open2015-01-24 13_51_18](https://cloud.githubusercontent.com/assets/39191/5889192/244a0b72-a3d0-11e4-8ab9-55fc64228aaa.gif)
20	22
21		-	## Installation
	23	+	### Installation
22	24
	25	+	npm install --global git-open
23	26
24		-	```sh
25		-	npm install --global git-open
26		-	```
	27	+	### Supported hosts
27	28
28		-
29		-	#### Supported:
30		-	* Github.com
31		-	* Gists on Github
32		-	* Bitbucket
33		-	* Atlassian Stash
34		-	* Gitlab.com
	29	+	* <github.com>
	30	+	* <gist.github.com>
	31	+	* <gitlab.com>
35	32		* Gitlab custom hosted (see below)
	33	+	* <bitbucket.org>
	34	+	* Atlassian Stash
36	35
	36	+	#### Gitlab support
37	37
38		-	## Gitlab support
39		-	To configure gitlab support you need to set gitopen.gitlab.domain:
	38	+	To configure gitlab support you need to set `gitopen.gitlab.domain`
	39	+
	40	+	git config --global gitopen.gitlab.domain [yourdomain.here]
	41	+
	42	+	or
	43	+
	44	+	git config gitopen.gitlab.domain [yourdomain.here] # in your local repository
	45	+
	46	+	## Related projects
	47	+
	48	+	See [hub](https://github.com/github/hub) for complete GitHub opening support.
	49	+	It's the official GitHub project and provides `hub browse`.
	50	+
	51	+	## Thanks
	52	+
	53	+	[jasonmccreary](https://github.com/jasonmccreary/) did
	54	+	[all the hard work](https://github.com/jasonmccreary/gh)
40	55
41		-	```
42		-	git config --global gitopen.gitlab.domain [yourdomain.here]
43		-	# or
44		-	git config gitopen.gitlab.domain [yourdomain.here] # in your local repository
45		-	```
	56	+	See the contributors tab for a growing list of people who have submitted PRs.
46	57
	58	+	## Contributing
47	59
48		-	## Thx
49		-	@jasonmccreary did [all the hard work](https://github.com/jasonmccreary/gh)
	60	+	Please provide examples of the URLs you are parsing with each PR.
50	61
51	62		## License
52	63
53	64		Copyright Jason McCreary & Paul Irish. Licensed under MIT.
54		-
55	65		http://opensource.org/licenses/MIT
56	66

readme additions and formatting