Skip to content

Commit

Permalink
Add badges and link to minicharts
Browse files Browse the repository at this point in the history
  • Loading branch information
FrancoisGuillem committed Aug 17, 2017
1 parent 7b9131d commit 515c796
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
[![Travis Build Status](https://travis-ci.org/rte-antares-rpackage/js-client-tmpl.svg?branch=master)](https://travis-ci.org/rte-antares-rpackage/js-client-tmpl)
[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/u2eqak19662etpu6/branch/master?svg=true
)](https://ci.appveyor.com/project/rte-antares-rpackage/js-client-tmpl)
[![codecov](https://codecov.io/gh/rte-antares-rpackage/js-client-tmpl/branch/master/graph/badge.svg)](https://codecov.io/gh/rte-antares-rpackage/js-client-tmpl)

# A template for robust client-side javascript libraries

This repository contains a template that can be used to create a new client-side javascript library. It has everything that is required to run automatic tests, use popular continuous integration tools (travis-ci.org and appveyor.com) and compute code coverage.
Expand Down Expand Up @@ -78,3 +83,9 @@ This prints information about coverage in the terminal, but it also creates a HT

## Configure continuous integration
The repository already contains configuration files for [Travis](https://travis-ci.org/), [Appveyor](https://www.appveyor.com/) and [codecov](https://codecov.io/gh). Create an account in each site and enable the three services for your github repository. After that, each time you will push your code on Github, Travis and Appveyor will retrieve the last version and run your tests. Travis will then upload a coverage report on Codecov.

## Examples
The repository already contains some sample scripts in `src` and `test/src`. For a concrete example, you can have a look at the repository of the [minicharts library](https://github.com/rte-antares-rpackage/minicharts).

## Contributing
If you have ideas to improve this framework, do not hesitate to contribute by creating issues or submitting pull requests to this repository.

0 comments on commit 515c796

Please sign in to comment.