STRLCPY/git-open

readme tweaks
Paul Irish committed with GitHub 7 years ago

f3dbce97

1 parent a15d53b6

Total 1 files

■ ■ ■ ■ ■ ■

README.md

		skipped 7 lines
8	8
9	9		```sh
10	10		git open [remote-name] [branch-name]
	11	+
11	12		git open issue
12	13		```
13	14
		skipped 16 lines
30	31		# opens https://github.com/REMOTE_UPSTREAM_USER/CURRENT_REPO/issues/123
31	32		```
32	33
33		-	### Installation
	34	+	## Installation
34	35
35		-	#### Without using a framework
	36	+	### Basic install
36	37
37	38		The preferred way of installation is to simply add the `git-open` script
38	39		somewhere into your path (e.g. add the directory to your `PATH` environment
39	40		or copy `git-open` into an existing included path like `/usr/local/bin`).
40	41
41		-	You can use also `npm` to install this package:
	42	+	### Install via NPM:
42	43
43	44		```sh
44	45		npm install --global git-open
45	46		```
46	47
47		-	#### Using Windows Powershell
	48	+	### Windows Powershell
48	49
49	50		Save git-open anywhere, say as ~/Documents/Scripts/git-open.sh and define
50	51		a function in your Powershell profile (see ~/Documents/WindowsPowerShell/profile.ps1) like this:
		skipped 3 lines
54	55		Set-Alias -Name gop -Value git-open
55	56		```
56	57
57		-	#### Using Windows with `cmd` terminal
	58	+	### Windows with `cmd` terminal
58	59
59	60		Save the `git-open` script in any place accessible via your `%PATH%` environment var.
60	61
61		-	#### Using a ZSH Framework
	62	+	### ZSH
62	63
63		-	##### [Antigen](https://github.com/zsh-users/antigen)
	64	+	#### [Antigen](https://github.com/zsh-users/antigen)
64	65
65	66		Add `antigen bundle paulirish/git-open` to your `.zshrc` with your other bundle
66	67		commands.
		skipped 3 lines
70	71		also add the plugin to a running zsh with `antigen bundle paulirish/git-open`
71	72		for testing before adding it to your `.zshrc`.
72	73
73		-	##### [Oh-My-Zsh](http://ohmyz.sh/)
	74	+	#### [Oh-My-Zsh](http://ohmyz.sh/)
74	75
75	76		1. `cd ~/.oh-my-zsh/custom/plugins`
76	77		1. `git clone https://github.com/paulirish/git-open.git`
77	78		1. Add `git-open` to your plugin list - edit `~/.zshrc` and change
78	79		`plugins=(...)` to `plugins=(... git-open)`
79	80
80		-	##### [Zgen](https://github.com/tarjoilija/zgen)
	81	+	#### [Zgen](https://github.com/tarjoilija/zgen)
81	82
82	83		Add `zgen load paulirish/git-open` to your .zshrc file in the same function
83	84		you're doing your other `zgen load` calls in. ZGen will take care of cloning
84	85		the repository the next time you run `zgen save`, and will also periodically
85	86		check for updates to the git repository.
86	87
87		-	##### [zplug](https://github.com/zplug/zplug)
	88	+	#### [zplug](https://github.com/zplug/zplug)
88	89
89	90		`zplug "paulirish/git-open", as:plugin`
90	91
91		-	### Supported remote repositories
	92	+	## Supported remote repositories
92	93
93	94		git-open can automatically guess the corresponding repository page for remotes
94	95		(default looks for `origin`) on the following hosts:
		skipped 5 lines
100	101		- bitbucket.org
101	102		- Atlassian Bitbucket Server (formerly _Atlassian Stash_)
102	103
103		-	#### GitLab support
	104	+	### GitLab support
104	105
105	106		To configure GitLab support you need to set some options.
106	107
		skipped 82 lines

readme tweaks