Skip to content

Commit 05820b9

Browse files
committed
Improve docs
1 parent cc71fbb commit 05820b9

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,27 @@
77

88
Sometimes you need to communicate about important changes to other developers on your project. In a small team, a Slack message will probably do, but in larger teams and distributed organizations (such as open source projects), reaching everyone can be a pain.
99

10-
`git-notify` allows you to inject announcements into your git commit messages, and display them to other developers when they pull those commits to their machine.
10+
`git-notify` allows you to inject announcements into your git commit messages, and display them to other developers:
1111

1212
```sh
1313
git commit -m 'git-notify: NEW PERF TOOLING AVAILABLE ...'
1414
```
1515

1616
Later, at a machine far far away:
17+
1718
![Demo](docs/demo.gif)
1819

20+
## Getting started
21+
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.
23+
1924
If you're using merge/squash commit strategy on GitHub, you can add them to the extended commit message when landing a PR:
2025

2126
![GitHub PR flow example](docs/github-example.png)
2227

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

25-
`git-notify` is intended for use in node-based projects.
30+
### Installation
2631

2732
Install the git-notify package as a devDependency:
2833

@@ -34,7 +39,7 @@ npm install --save-dev git-notify
3439
yarn add -D git-notify
3540
```
3641

37-
Next, we'll configure `git-notify` to run automatically when other developers pull commits that contain git messages. Below we show how to install them with the excellent [husky](https://github.com/typicode/husky) node library. For other approaches, see the [Git Hooks](#git-hooks) section.
42+
Next, we'll configure `git-notify` to run automatically when other developers pull commits that contain git messages. Below we show how to achieve this with the excellent [husky](https://github.com/typicode/husky) library. For other approaches, see the [Git Hooks](#git-hooks) section later in this document.
3843

3944
### Installing hooks with husky
4045

docs/github-example.png

12.6 KB
Loading

0 commit comments

Comments
 (0)