Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dkhunt27 committed May 1, 2015
1 parent 2df76fa commit 6aa5a51
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![NPM version](https://badge.fury.io/js/angular-directive-percentage.png)](http://badge.fury.io/js/angular-directive-percentage)
[![Bower version](https://badge.fury.io/bo/angular-directive-percentage.png)](http://badge.fury.io/bo/angular-directive-percentage)
[![Build Status](https://travis-ci.org/dkhunt27/angular-directive-percentage.svg?branch=master)](https://travis-ci.org/dkhunt27/angular-directive-percentage)
[![Coverage Status](https://coveralls.io/repos/dkhunt27/angular-directive-percentage/badge.svg)](https://coveralls.io/r/dkhunt27/angular-directive-percentage)
[![Coverage Status](https://coveralls.io/repos/dkhunt27/angular-directive-percentage/badge.svg?branch=master)](https://coveralls.io/r/dkhunt27/angular-directive-percentage?branch=master)

## Credit

Expand Down Expand Up @@ -57,12 +57,17 @@ Basic example:
## Tests:

1. Install test deps: `npm install` and `bower install`
2. Run: `npm test` or `./node_modules/karma/bin/karma start`
2. Run: `npm test` or `./node_modules/karma/bin/karma start`.

###### Note: If running locally, you might get an error about can't submit to coveralls. This is only required if you want the code coverage badge for your forked repo. See below for setup.

## Coveralls.io

Using coveralls.io for the code coverage badge. Using instanbul, karma-coverage, and karma-coveralls to generate code coverage and push to coveralls.io.
The push to coveralls.io requires the repo token. I am using an environment variable COVERALLS_REPO_TOKEN_FOR_ANGULAR_DIRECTIVE_PERCENTAGE that gets mapped
to the required COVERALLS_REPO_TOKEN per test run. The travis build sets this environment variable using [encrypted](http://docs.travis-ci.com/user/encryption-keys/)
The push to coveralls.io requires the repo token. I am using an environment variable

$ export COVERALLS_REPO_TOKEN_FOR_ANGULAR_DIRECTIVE_PERCENTAGE=[your coveralls repo token]

that gets mapped to the required COVERALLS_REPO_TOKEN per test run. The travis build sets this environment variable using [encrypted](http://docs.travis-ci.com/user/encryption-keys/)
variables. However, if running this locally, you will need to setup your forked repo in [coveralls.io](https://coveralls.io/) and set that environment
variable (COVERALLS_REPO_TOKEN_FOR_ANGULAR_DIRECTIVE_PERCENTAGE) to your repo token
variable to your repo token
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "angular-directive-percentage",
"version": "0.2.0",
"version": "0.3.0",
"main": "angular-directive-percentage.js",
"ignore": [
".editorconfig",
Expand Down

0 comments on commit 6aa5a51

Please sign in to comment.