Skip to content

Commit

Permalink
docs(usage): wording (#131)
Browse files Browse the repository at this point in the history
  • Loading branch information
linrongbin16 authored Nov 17, 2023
1 parent e25c6d9 commit f2db69f
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,12 +108,13 @@ You could use below command:

- `GitLink`: generate git link and copy to clipboard.
- `GitLink!`: generate git link and open in browser.
- `GitLink blame`: generate the `/blame` url and copy to clipboard, by default is `browse`.
- `GitLink blame`: generate the `/blame` url and copy to clipboard.
- `GitLink! blame`: generate the `/blame` url and open in browser.

> Note:
>
> - `browse` router could generate for other git host websites, e.g., `/src` for bitbucket.org.
> - `blame` router could generate for other git host websites, e.g., `/annotate` for bitbucket.org.
There're two **routers** provided:

- `browse`: generate the `/blob` urls (default router in `GitLink`), also work for other git host websites, e.g. generate `/src` for bitbucket.org.
- `blame`: generate the `/blame` urls, also work for other git host websites, e.g. generate `/annotate` for bitbucket.org.

<details>
<summary><i>Click here to see recommended key mappings</i></summary>
Expand Down

0 comments on commit f2db69f

Please sign in to comment.