docs: update README and manual

This commit is contained in:
phwt 2022-08-12 16:55:21 +07:00
parent 153adb5089
commit 6a41a88a0c
2 changed files with 11 additions and 1 deletions

View file

@ -150,7 +150,7 @@ Please provide examples of the URLs you are parsing with each PR.
### Testing:
You'll need to install [bats](https://github.com/sstephenson/bats#installing-bats-from-source), the Bash automated testing system. It's also available as `brew install bats`
You'll need to install [bats](https://github.com/bats-core/bats-core), the Bash automated testing system. It's also available as `brew install bats-core`
```sh
git submodule update --init # pull in the assertion libraries

View file

@ -23,6 +23,9 @@ git hosting services are supported.
it will open the webpage with that issue. See `EXAMPLES` for more information.
This only works on GitHub, GitLab, Visual Studio Team Services and Team Foundation Server at the moment.
`-d`, `--default-branch`
Open the repository as if you were in the default branch (`master`/`main`)
`-s`, `--suffix` some_suffix
Append the given suffix to the url
@ -59,6 +62,13 @@ git open --issue
If branches use naming convention of `issues/#123`, it opens
https://github.com/TRACKED_REMOTE_USER/CURRENT_REPO/issues/123
```sh
git open --default-branch
```
It won't suffix the url with `/tree/CURRENT_BRANCH` even if you aren't currently on `master` or `main` branch, it opens https://github.com/TRACKED_REMOTE_USER/CURRENT_REPO/
```sh
git open --suffix pulls
```