Skip to content

Commit 1bef6b1

Browse files
committed
docs: add badges to readme
1 parent 13d7a60 commit 1bef6b1

File tree

6 files changed

+779
-17
lines changed

6 files changed

+779
-17
lines changed

.husky/commit-msg

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
if [ "$CI" = "true" ]
2+
then
3+
# disable commitlint for CI environments
4+
exit 0
5+
else
6+
yarn commitlint --edit
7+
fi

.lintstagedrc.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"*.{js,ts}": "yarn lint:fix",
3+
"*.md": "yarn lint:fix"
4+
}

.releaserc.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
2-
"branches": [
3-
"master"
4-
],
5-
"plugins": [
2+
"branches": [
3+
"master"
4+
],
5+
"plugins": [
66
"@semantic-release/commit-analyzer",
77
"@semantic-release/release-notes-generator",
88
"@semantic-release/npm",
99
"@semantic-release/github"
10-
]
10+
]
1111
}

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
<div align="center">
2-
<h1>@ver0/react-hooks-testing</h1>
3-
<p>🧪 Test your React hooks with ease!</p>
4-
</div>
2+
<h1>@ver0/react-hooks-testing</h1>
3+
4+
<img alt="NPM Version" src="https://img.shields.io/npm/v/%40ver0%2Freact-hooks-testing?style=flat-square">
5+
<img alt="NPM Downloads" src="https://img.shields.io/npm/dm/%40ver0%2Freact-hooks-testing?style=flat-square">
6+
<img alt="Dependents (via libraries.io), scoped npm package" src="https://img.shields.io/librariesio/dependents/npm/%40ver0/react-hooks-testing?style=flat-square">
7+
<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/ver0-project/react-hooks-testing/ci.yml?style=flat-square">
8+
<img alt="Codecov" src="https://img.shields.io/codecov/c/github/ver0-project/react-hooks-testing?token=Y2K96S71RH&style=flat-square">
9+
<img alt="NPM Type Definitions" src="https://img.shields.io/npm/types/%40react-hookz%2Fdeep-equal?style=flat-square">
510

6-
---
11+
<p><br/>🧪 Test your React hooks with ease!</p>
12+
</div>
713

814
### Features
915

package.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,22 @@
2828
"main": "dist/index.js",
2929
"types": "dist/index.d.ts",
3030
"scripts": {
31+
"postinstall": "husky",
3132
"build": "yarn build:clean && yarn tsc -p tsconfig.build.json",
3233
"build:clean": "rimraf dist",
3334
"test": "vitest --run",
3435
"test:coverage": "vitest --run --coverage"
3536
},
3637
"packageManager": "yarn@4.6.0",
3738
"devDependencies": {
39+
"@commitlint/cli": "^19.7.1",
40+
"@commitlint/config-conventional": "^19.7.1",
3841
"@types/react": "^19.0.8",
3942
"@types/react-dom": "^19.0.3",
4043
"@vitest/coverage-v8": "^3.0.5",
44+
"husky": "^9.1.7",
4145
"jsdom": "^26.0.0",
46+
"lint-staged": "^15.4.3",
4247
"pinst": "^3.0.0",
4348
"react": "^19.0.0",
4449
"react-dom": "^19.0.0",

0 commit comments

Comments
 (0)