Skip to content

Commit 1e34257

Browse files
committed
Merge pull request #5 from depcheck/readme
Add information in README file.
2 parents 2af0250 + fa55d1c commit 1e34257

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

+19-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,24 @@
11
# depcheck-web
22

3-
Post depcheck report to web service.
3+
[![Build Status](https://travis-ci.org/depcheck/depcheck-web.svg?branch=master)](https://travis-ci.org/depcheck/depcheck-web)
4+
[![Depcheck](https://depcheck.tk/github/depcheck/depcheck-web/master.svg)](https://github.com/depcheck/depcheck-web)
5+
6+
Post [depcheck](https://github.com/depcheck/depcheck) result to [depcheck service](https://depcheck.tk) and generate report and badge.
7+
8+
## Usage
9+
10+
1. Install [depcheck](https://www.npmjs.com/package/depcheck) and [depcheck-web](https://www.npmjs.com/package/depcheck-web) from npm.
11+
2. Add `depcheck --json | depcheck-web` to script section in your `.travis.yml` file.
12+
13+
## Example
14+
15+
Check this project's [`.travis.yml`](https://github.com/depcheck/depcheck-web/blob/master/.travis.yml) file. It invokes the `npm run depcheck-web` command in script section.
16+
17+
Then, in [`package.json`](https://github.com/depcheck/depcheck-web/blob/master/package.json) file, `depcheck-web` script is defined as `depcheck --json | node ./bin/depcheck-web` (self-check) command.
18+
19+
## Known issues
20+
21+
- Currently, only Travis CI builds from GitHub provider is supported.
422

523
## License
624

0 commit comments

Comments
 (0)