Skip to content

Commit 1246e48

Browse files
committed
udpate doc
1 parent 5544f63 commit 1246e48

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,33 @@
66
77
[![CI](https://github.com/emacs-sideline/sideline-blame/actions/workflows/test.yml/badge.svg)](https://github.com/emacs-sideline/sideline-blame/actions/workflows/test.yml)
88

9+
## 🔨 Quickstart
10+
11+
```elisp
12+
(leaf sideline
13+
:init
14+
(setq sideline-backends-left '((sideline-blame . down))))
15+
```
16+
17+
Then open a file with source control, then do:
18+
19+
```
20+
M-x sideline-mode
21+
```
22+
23+
If you want to enable it everywhere, put this line in your `init.el`:
24+
25+
```elisp
26+
(global-sideline-mode 1)
27+
```
28+
29+
See library [sideline](https://github.com/emacs-sideline/sideline) for more
30+
information.
31+
932
## 🔗 References
1033

1134
* [vc-msg](https://github.com/redguardtoo/vc-msg)
35+
* [blamer.el](https://github.com/Artawower/blamer.el)
1236

1337
## Contribute
1438

0 commit comments

Comments
 (0)