Skip to content

Commit

Permalink
docs(usage): improve 'remote' parameter wording
Browse files Browse the repository at this point in the history
  • Loading branch information
linrongbin16 committed Mar 13, 2024
1 parent 0ff97f4 commit 957f842
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,11 +129,12 @@ There're several **router types**:
> - `default_branch` generate the `/main` or `/master` url: https://bitbucket.org/gitlinkernvim/gitlinker.nvim/src/master/.gitignore#lines-9:14.
> - `current_branch` generate the current branch url: https://bitbucket.org/gitlinkernvim/gitlinker.nvim/src/master/.gitignore#lines-9:14.
There're several arguments:
To specify the remote when there're multiple git remotes, add `remote=xxx` parameter, for example:

- `remote`: by default `GitLink` will use the first detected remote (usually it's `origin`), but if you need to specify other remotes, please use `remote=xxx`. For example:
- `GitLink remote=upstream`: copy `blob` url to clipboard for `upstream`.
- `GitLink! blame remote=upstream`: open `blame` url in browser for `upstream`.
- `GitLink remote=upstream`: copy `blob` url to clipboard for the `upstream` remote.
- `GitLink! blame remote=upstream`: open `blame` url in browser for the `upstream` remote.

> By default `GitLink` will use the first detected remote (usually it's `origin`).
### API

Expand Down

0 comments on commit 957f842

Please sign in to comment.