Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Rupert Bedford committed May 11, 2016
1 parent a879cfe commit 173eada
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,29 @@
[![Build Status](https://img.shields.io/travis/renalreg/radar-client/master.svg)](https://travis-ci.org/renalreg/radar-client) [![Coveralls](https://img.shields.io/coveralls/renalreg/radar-client.svg)](https://coveralls.io/github/renalreg/radar-client)

[![Sauce Test Status](https://saucelabs.com/browser-matrix/radar.svg)](https://saucelabs.com/u/radar)

## Development Build

During development you will probably want to run `gulp watch`. This will build
a development version of the application and watch for any changes to the
source code. You can use `gulp build` if you just want to build a development
version without watching for changes afterwards.

The terminal output will show any JavaScript lint errors. You can also check for
lint errors using `gulp lint`.

## Distribution Build

You can build a distribution version of the application using `gulp build:dist`.
This builds an optimised version of the application in the `dist` folder. Source
files are concatenated and minified.

## Gulp Tasks

* `clean` - delete built files
* `build` - build the application for development
* `build:dist` - build the application for distribution
* `watch` - build the application and watch for changes
* `lint` - lint the JavaScript files
* `test` - run the tests
* `coverage` - run the tests and produce a coverage report

0 comments on commit 173eada

Please sign in to comment.