Skip to content

Commit d6ed9d7

Browse files
committed
Show more features in the README
Closes GH-39
1 parent 9363995 commit d6ed9d7

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,34 @@ This package was originally created by [@psykzz](https://github.com/psykzz) and
1616

1717
## How to use
1818

19-
Place the text insertion cursor on the line you are interested in, then press <kbd>Ctrl</kbd><kbd>Alt</kbd><kbd>B</kbd> (Mac/Windows) or <kbd>Ctrl</kbd><kbd>Shift</kbd><kbd>Q</kbd> (Linux).
19+
Place the text cursor on the line you are interested in, then press <kbd>Ctrl</kbd><kbd>Alt</kbd><kbd>B</kbd> (Mac/Windows) or <kbd>Ctrl</kbd><kbd>Shift</kbd><kbd>Q</kbd> (Linux).
2020

2121
(Instead of pressing the keyboard shortcut, you can alternatively right click and select *Git Blame* from the context menu)
2222

2323
The blame information will appear:
2424

25-
![Screenshot](https://raw.githubusercontent.com/frou/st3-gitblame/master/screenshot.png)
25+
![Screenshot](https://raw.githubusercontent.com/frou/st3-gitblame/master/docs/screenshot-blame.png)
2626

27-
You can then click `[Show]` to show the commit in full, or `[Copy]` to copy the Commit ID (aka SHA) to your clipboard. To close the blame information, click the `×` icon, or press the keyboard shortcut again.
27+
If you want, you can then click `[Show]` to show the commit in full:
28+
29+
![Screenshot](https://raw.githubusercontent.com/frou/st3-gitblame/master/docs/screenshot-blame-show.png)
30+
31+
...or click `[Copy]` to copy the Commit ID (aka SHA) to your clipboard.
32+
33+
If the latest blame information was not as illuminating as you hoped for, click the `[Prev]` to step back through multiple previous commits that affected the line.
34+
35+
To close the blame information, click the `×` icon, or press the keyboard shortcut again while the text cursor is still on the same line.
2836

2937
## Advanced use
3038

31-
In combination with Sublime Text's *Multiple Cursor* feature, you can query blame information for more than one line simultaneously by first placing a cursor on each line you are interested in.
39+
In combination with Sublime Text's *Multiple Selection* feature, you can query blame information for more than one line simultaneously by first placing a text cursor on each line you are interested in, and then running as described above.
40+
41+
You can also query blame information for every line in the entire file simultaneously by pressing <kbd>Ctrl</kbd><kbd>Alt</kbd><kbd>Shift</kbd><kbd>B</kbd> (Mac/Windows) or <kbd>Ctrl</kbd><kbd>Shift</kbd><kbd>C</kbd> (Linux). Doing this shows blame information in a different style (it's located to the left of the content, and more compact, but with fewer features):
42+
43+
![Screenshot](https://raw.githubusercontent.com/frou/st3-gitblame/master/docs/screenshot-blameall.png)
44+
45+
To close all of them, click the `×` icon on any one of them, or press the keyboard shortcut again.
3246

33-
You can also query blame information for every line in the entire file simultaneously by pressing <kbd>Ctrl</kbd><kbd>Alt</kbd><kbd>Shift</kbd><kbd>B</kbd> (Mac/Windows) or <kbd>Ctrl</kbd><kbd>Shift</kbd><kbd>C</kbd> (Linux). To close all of them, click the `×` icon on one of them, or press the keyboard shortcut again.
47+
As well as via keyboard shortcuts, this package's commands are also made available in the *Command Palette*. Type "Git Blame" into it to find them:
3448

35-
This package's commands are also made available in the *Command Palette*. Type "Git Blame" into it to find them.
49+
![Screenshot](https://raw.githubusercontent.com/frou/st3-gitblame/master/docs/screenshot-palette.png)

0 commit comments

Comments
 (0)