Skip to content

Commit a7b028a

Browse files
committed
Fix package metadata and readme links
1 parent 8849d00 commit a7b028a

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ git commit -m 'git-notify: NEW PERF TOOLING AVAILABLE ...'
1414

1515
Later, at a machine far far away:
1616

17+
<img src="https://github.com/jevakallio/git-notify/blob/master/docs/demo.gif?raw=true" alt="GitHub PR flow example"></img>
18+
1719
![Demo](docs/demo.gif)
1820

1921
Simple as that.
@@ -24,7 +26,7 @@ Just add `"git-notify:"` to your git commit messages, and the rest of that parag
2426

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

27-
![GitHub PR flow example](docs/github-example.png)
29+
<img src="https://github.com/jevakallio/git-notify/blob/master/docs/github-example.png?raw=true" alt="GitHub PR flow example"></img>
2830

2931
Next we'll show how to install `git-notify` to your `npm` (or `yarn`) based project.
3032

package.json

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,18 @@
33
"license": "MIT",
44
"main": "dist/index.js",
55
"typings": "dist/index.d.ts",
6+
"repository": "https://github.com/jevakallio/git-notify",
7+
"description": "Communicate important updates to your team via git commit messages",
8+
"contributors": [
9+
"@jevakallio"
10+
],
11+
"keywords": [
12+
"git",
13+
"hook",
14+
"message",
15+
"notify",
16+
"husky"
17+
],
618
"files": [
719
"dist",
820
"src"
@@ -23,7 +35,6 @@
2335
"analyze": "size-limit --why"
2436
},
2537
"dependencies": {
26-
"@types/git-raw-commits": "^2.0.0",
2738
"boxen": "^5.0.0",
2839
"chalk": "^4.1.0",
2940
"git-raw-commits": "^2.0.10",
@@ -56,6 +67,7 @@
5667
}
5768
],
5869
"devDependencies": {
70+
"@types/git-raw-commits": "^2.0.0",
5971
"@size-limit/preset-small-lib": "^4.9.2",
6072
"husky": "^5.1.1",
6173
"size-limit": "^4.9.2",

0 commit comments

Comments
 (0)