Skip to content

Commit f3dbce9

Browse files
authored
readme tweaks
1 parent a15d53b commit f3dbce9

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Type `git open` to open the repo website (GitHub, GitLab, Bitbucket) in your bro
88

99
```sh
1010
git open [remote-name] [branch-name]
11+
1112
git open issue
1213
```
1314

@@ -30,21 +31,21 @@ $ git open issue
3031
# opens https://github.com/REMOTE_UPSTREAM_USER/CURRENT_REPO/issues/123
3132
```
3233

33-
### Installation
34+
## Installation
3435

35-
#### Without using a framework
36+
### Basic install
3637

3738
The preferred way of installation is to simply add the `git-open` script
3839
somewhere into your path (e.g. add the directory to your `PATH` environment
3940
or copy `git-open` into an existing included path like `/usr/local/bin`).
4041

41-
You can use also `npm` to install this package:
42+
### Install via NPM:
4243

4344
```sh
4445
npm install --global git-open
4546
```
4647

47-
#### Using Windows Powershell
48+
### Windows Powershell
4849

4950
Save git-open anywhere, say as ~/Documents/Scripts/git-open.sh and define
5051
a function in your Powershell profile (see ~/Documents/WindowsPowerShell/profile.ps1) like this:
@@ -54,13 +55,13 @@ function git-open { cmd /c "C:\Program Files\Git\usr\bin\bash.exe" "~/Documents/
5455
Set-Alias -Name gop -Value git-open
5556
```
5657
57-
#### Using Windows with `cmd` terminal
58+
### Windows with `cmd` terminal
5859
5960
Save the `git-open` script in any place accessible via your `%PATH%` environment var.
6061
61-
#### Using a ZSH Framework
62+
### ZSH
6263
63-
##### [Antigen](https://github.com/zsh-users/antigen)
64+
#### [Antigen](https://github.com/zsh-users/antigen)
6465
6566
Add `antigen bundle paulirish/git-open` to your `.zshrc` with your other bundle
6667
commands.
@@ -70,25 +71,25 @@ start zsh, and periodically checking for updates to the git repository. You can
7071
also add the plugin to a running zsh with `antigen bundle paulirish/git-open`
7172
for testing before adding it to your `.zshrc`.
7273
73-
##### [Oh-My-Zsh](http://ohmyz.sh/)
74+
#### [Oh-My-Zsh](http://ohmyz.sh/)
7475
7576
1. `cd ~/.oh-my-zsh/custom/plugins`
7677
1. `git clone https://github.com/paulirish/git-open.git`
7778
1. Add `git-open` to your plugin list - edit `~/.zshrc` and change
7879
`plugins=(...)` to `plugins=(... git-open)`
7980
80-
##### [Zgen](https://github.com/tarjoilija/zgen)
81+
#### [Zgen](https://github.com/tarjoilija/zgen)
8182
8283
Add `zgen load paulirish/git-open` to your .zshrc file in the same function
8384
you're doing your other `zgen load` calls in. ZGen will take care of cloning
8485
the repository the next time you run `zgen save`, and will also periodically
8586
check for updates to the git repository.
8687
87-
##### [zplug](https://github.com/zplug/zplug)
88+
#### [zplug](https://github.com/zplug/zplug)
8889
8990
`zplug "paulirish/git-open", as:plugin`
9091
91-
### Supported remote repositories
92+
## Supported remote repositories
9293
9394
git-open can automatically guess the corresponding repository page for remotes
9495
(default looks for `origin`) on the following hosts:
@@ -100,7 +101,7 @@ git-open can automatically guess the corresponding repository page for remotes
100101
- bitbucket.org
101102
- Atlassian Bitbucket Server (formerly _Atlassian Stash_)
102103
103-
#### GitLab support
104+
### GitLab support
104105
105106
To configure GitLab support you need to set some options.
106107

0 commit comments

Comments
 (0)