Skip to content

Commit

Permalink
remove repo setup instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Eevert Saukkokoski committed Oct 16, 2014
1 parent 76ce90b commit 9ddda86
Showing 1 changed file with 0 additions and 26 deletions.
26 changes: 0 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,3 @@ ag-restful
[![Coverage Status](https://img.shields.io/coveralls/AppGyver/ag-restful.svg)](https://coveralls.io/r/AppGyver/ag-restful)

restful resource object builder

## Continuous integration setup

### Getting started

This project comes with a [Travis CI](https://travis-ci.org/) setup. All you need to do is enable Travis for your project through its web interface.

If you intend to set up continuous deployment or code coverage reports, the Travis command line client comes in useful. It's installed as a Ruby gem.

gem install travis

### Continuous deployment

The project is configured for deployment to npm on successfully building, tagged commits. You'll only need to provide your npm api key for Travis to work its magic.

cat ~/.npmrc | grep '_auth' | awk -F ' = ' '{print $2}' | travis encrypt --add deploy.api_key

This reads the key from your .npmrc file and saves it to the travis configuration.

### Code coverage reports

The project is set up with a test runner that is compatible with the [Coveralls](http://coveralls.io/) reporting tool. Travis will push the reports to Coveralls for you, if you provide it with the repository specific private token.

travis encrypt COVERALLS_REPO_TOKEN=<your token here> --add

You might find that the `grunt travis` task doesn't pass without this token being set as an env variable. If you're using Travis without code coverage reporting, remove the relevant `mochacov` task configuration segment.

0 comments on commit 9ddda86

Please sign in to comment.