Skip to content

Commit 013cd29

Browse files
committed
Improve readme
1 parent 05820b9 commit 013cd29

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,19 @@ Later, at a machine far far away:
1717

1818
![Demo](docs/demo.gif)
1919

20-
## Getting started
20+
Simple as that.
2121

22-
Simply add `git-notify:` to your git commit messages, and the rest of that paragraph will be displayed when another developer pulls that commit.
22+
## How to use git-notify?
23+
24+
Just add `"git-notify:"` to your git commit messages, and the rest of that paragraph will be displayed when another developer pulls that commit, or switches from a branch that does not contain that commit to one that does.
2325

2426
If you're using merge/squash commit strategy on GitHub, you can add them to the extended commit message when landing a PR:
2527

2628
![GitHub PR flow example](docs/github-example.png)
2729

28-
Next we'll show how to [install](#installation) `git-notify` to your `npm` (or `yarn`) based project.
30+
Next we'll show how to install `git-notify` to your `npm` (or `yarn`) based project.
2931

30-
### Installation
32+
## Getting Started
3133

3234
Install the git-notify package as a devDependency:
3335

0 commit comments

Comments
 (0)