Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] fix headline in README #38

Merged
merged 1 commit into from
Apr 5, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
#karma-coveralls [![Build Status](https://img.shields.io/travis/caitp/karma-coveralls/master.svg?style=flat)](https://travis-ci.org/caitp/karma-coveralls) [![dependencies](https://img.shields.io/david/caitp/karma-coveralls.svg?style=flat)](https://david-dm.org/caitp/karma-coveralls) [![Coverage Status](https://img.shields.io/coveralls/caitp/karma-coveralls/master.svg?style=flat)](https://coveralls.io/r/caitp/karma-coveralls?branch=master)
# karma-coveralls [![Build Status](https://img.shields.io/travis/caitp/karma-coveralls/master.svg?style=flat)](https://travis-ci.org/caitp/karma-coveralls) [![dependencies](https://img.shields.io/david/caitp/karma-coveralls.svg?style=flat)](https://david-dm.org/caitp/karma-coveralls) [![Coverage Status](https://img.shields.io/coveralls/caitp/karma-coveralls/master.svg?style=flat)](https://coveralls.io/r/caitp/karma-coveralls?branch=master)

A Karma plugin to upload coverage reports generated by [karma-coverage][karma-coverage] to [coveralls.io](https://coveralls.io/).

Based on the work on [grunt-karma-coveralls](https://github.com/mattjmorrison/grunt-karma-coveralls),
with the primary difference being that this plugin does not depend on grunt, and simply exists as a
[Karma](http://karma-runner.github.io/) plugin.

##Installation
## Installation

```shell
npm install karma-coveralls --save-dev
```

##Usage
## Usage

In your karma configuration, ensure your list of reporters contains at the very least `coverage` (see [karma-coverage][karma-coverage]) and `coveralls`, for example:

Expand Down Expand Up @@ -47,15 +47,15 @@ Treat it like a password. If you need to include it in a public repo you should
Be patiant when sending coverage information to coveralls, it can take upto 4 hours for things to
start showing up properly.

##Contribution
## Contribution

Please send pull requests improving the usage and fixing bugs, improving documentation and providing
better examples, or providing some testing, because these things are important.

##Example projects using this plugin
## Example projects using this plugin
* [es6-library-boilerplate](https://github.com/CurtisHumphrey/es6-library-boilerplate)

##License
## License

The MIT License (MIT)

Expand Down