Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aadityataparia committed Jun 4, 2019
1 parent 0c877e6 commit 72ca5a7
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,37 +31,40 @@

## Other packages

- [@commitlint/cli](https://github.com/conventional-changelog/commitlint) - Linting commits
- [Husky](https://github.com/typicode/husky) - Git hooks made easy
- [browserslist](https://github.com/browserslist/browserslist#readme) - browserlist used by babel, eslint, postcss, etc.
- [coveralls](https://github.com/nickmerwin/node-coveralls#readme) - upload coverage to coveralls.io
- [mock-require](https://github.com/boblauer/mock-require) - Simple, intuitive mocking of Node.js modules.
- [@commitlint/cli](https://github.com/conventional-changelog/commitlint) - Linting commits
- [Husky](https://github.com/typicode/husky) - Git hooks made easy
- [browserslist](https://github.com/browserslist/browserslist#readme) - browserlist used by babel, eslint, postcss, etc.
- [coveralls](https://github.com/nickmerwin/node-coveralls#readme) - upload coverage to coveralls.io
- [mock-require](https://github.com/boblauer/mock-require) - Simple, intuitive mocking of Node.js modules.

## Usage

### Husky and commitlint

add `.huskyrc` to your root folder

```rc
{
"hooks": {
"commit-msg": "yarn commitlint -e $HUSKY_GIT_PARAMS"
}
}
```

add `commitlint.config.js`

```js
module.exports = {
extends: ['@commitlint/config-conventional']
};
```

### Upload to Coveralls
### Upload coverage to Coveralls

set `COVERALLS_REPO_TOKEN` environment variable
run tests with `lcov` reporter
Upload with this command
```sh
cat ./coverage/lcov.info | yarn coveralls
```
Upload with this command:

```sh
cat ./coverage/lcov.info | yarn coveralls
```

0 comments on commit 72ca5a7

Please sign in to comment.