Skip to content

Commit 57ab6ce

Browse files
committed
Update reamde
1 parent f5a07aa commit 57ab6ce

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

+16
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,19 @@ $ replace-bad-characters test.txt
2020

2121
This vim script defines a function that will (mostly) format sentences on one line.
2222
It screws up on colons and and question marks if text is after it, but otherwise is fairly accurate.
23+
24+
### Usage
25+
26+
```vim
27+
:call FormatSentence()
28+
```
29+
30+
To attach it to a key sequence, for example `Ctrl+Shift+p`
31+
32+
```vim
33+
nnoremap <C-S-p> :call FormatSentence()<CR>
34+
```
35+
36+
## Contribution
37+
38+
If you'd like to contribute, please open a pull require on [the Github](https://github.com/bytetools/formatting-tools/) unless you work for Bytetools and have permissions.

0 commit comments

Comments
 (0)