Skip to content

Commit

Permalink
Docs: Added coverage reporting
Browse files Browse the repository at this point in the history
  • Loading branch information
dcodeIO committed Jan 18, 2017
1 parent cbaaae9 commit 8cff92f
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 7 deletions.
4 changes: 4 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,7 @@ matrix:
script:
- travis_wait npm run zuul
- sleep 3
include:
- node_js: 6
script:
- npm run coverage
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# <p align="center"><img alt="protobuf.js" src="https://github.com/dcodeIO/protobuf.js/raw/master/pbjs.png" width="120" height="104" /></p>

[![][travis-image]][travis-url] [![][david-image]][david-url] [![][npm-dl-image]][npm-url] [![][npm-image]][npm-url] [![][paypal-image]][paypal-url]
[![][travis-image]][travis-url] [![][coverage-image]][coverage-url] [![][downloads-image]][npm-url] [![][npm-image]][npm-url] [![][donate-image]][donate-url]

**Protocol Buffers** are a language-neutral, platform-neutral, extensible way of serializing structured data for use in communications protocols, data storage, and more, originally designed at Google ([see](https://developers.google.com/protocol-buffers/)).

**protobuf.js** is a pure JavaScript implementation with TypeScript support for node and the browser. It's super easy to use, blazingly fast and works out of the box on .proto files!

[travis-image]: https://img.shields.io/travis/dcodeIO/protobuf.js.svg
[travis-url]: https://travis-ci.org/dcodeIO/protobuf.js
[david-url]: https://david-dm.org/dcodeIO/protobuf.js
[david-image]: https://img.shields.io/david/dcodeIO/protobuf.js.svg
[coverage-image]: https://coveralls.io/repos/github/dcodeIO/protobuf.js/badge.svg?branch=master
[coverage-url]: https://coveralls.io/github/dcodeIO/protobuf.js?branch=master
[npm-image]: https://img.shields.io/npm/v/protobufjs.svg
[npm-url]: https://npmjs.org/package/protobufjs
[npm-dl-image]: https://img.shields.io/npm/dm/protobufjs.svg
[paypal-image]: https://img.shields.io/badge/donate-feels%20good%2C%20I%20promise-333333.svg
[paypal-url]: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=dcode%40dcode.io&item_name=Open%20Source%20Software%20Contribution&item_number=dcodeIO%2Fprotobuf.js
[downloads-image]: https://img.shields.io/npm/dm/protobufjs.svg
[donate-image]: https://img.shields.io/badge/donate-%E2%9D%A4-ff2244.svg
[donate-url]: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=dcode%40dcode.io&item_name=Open%20Source%20Software%20Contribution&item_number=dcodeIO%2Fprotobuf.js

**Recommended read:** [Changes in protobuf.js 6.0](https://github.com/dcodeIO/protobuf.js/wiki/Changes-in-protobuf.js-6.0)

Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"bench": "node bench",
"build": "gulp",
"changelog": "node scripts/changelog -w",
"coverage": "istanbul cover node_modules/tape/bin/tape tests/*.js tests/node/*.js",
"coverage": "istanbul cover node_modules/tape/bin/tape tests/*.js tests/node/*.js && cat coverage/lcov.info | coveralls",
"docs": "jsdoc -c jsdoc.docs.json -R README.md",
"lint": "eslint src runtime",
"pages": "node scripts/pages",
Expand Down Expand Up @@ -66,6 +66,7 @@
"browserify-wrap": "^1.0.2",
"bundle-collapser": "^1.2.1",
"chalk": "^1.1.3",
"coveralls": "^2.11.15",
"escodegen": "^1.8.1",
"eslint": "^3.13.1",
"esprima": "^3.1.3",
Expand Down

0 comments on commit 8cff92f

Please sign in to comment.