Skip to content

Commit

Permalink
docs(readme): Updates the readme with new badges and docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
ryasmi committed Sep 27, 2017
1 parent 9564047 commit fd4a0f1
Showing 1 changed file with 24 additions and 11 deletions.
35 changes: 24 additions & 11 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,31 @@
# xapi-validation
> A package for validating xAPI Statements.

[![NPM Package Version](https://badge.fury.io/js/xapi-validation.svg)](https://www.npmjs.com/package/xapi-validation)
[![Build Status](https://travis-ci.org/LearningLocker/xapi-validation.svg?branch=master)](https://travis-ci.org/LearningLocker/xapi-validation)
[![Dependencies](https://david-dm.org/LearningLocker/xapi-validation.svg)](https://david-dm.org/LearningLocker/xapi-validation)
[![Dev Dependencies](https://david-dm.org/LearningLocker/xapi-validation/dev-status.svg)](https://david-dm.org/LearningLocker/xapi-validation?type=dev)
[![Test Coverage](https://codecov.io/gh/LearningLocker/xapi-validation/branch/master/graph/badge.svg)](https://codecov.io/gh/LearningLocker/xapi-validation)
[![Greenkeeper badge](https://badges.greenkeeper.io/LearningLocker/xapi-validation.svg)](https://greenkeeper.io/)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![Join the chat at https://gitter.im/LearningLocker/learninglocker](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/LearningLocker/learninglocker?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)


This is Learning Locker's package for validating xAPI Statements. The package aims to return all of the problems with an xAPI statement in one function call. Since this package is part of Learning Locker, it has been conformance tested. You can [try this package out on RunKit](https://runkit.com/58834fa5d14b5b0013806bde/5883507a9faa130014213d6a).

*Learning Locker is a trademark of [HT2 Inc.](http://ht2labs.com)*

### Installation
To install all of Learning Locker, see the [installation documentation](http://docs.learninglocker.net/guides-installing/). To install just the xAPI validation package, you can follow the instructions below.

```js
npm install --save xapi-validation
npm i xapi-validation
```

[Try it out on RunKit](https://runkit.com/58834fa5d14b5b0013806bde/5883507a9faa130014213d6a).

## Why?
1. Find and return all of the problems with your xAPI statements in one function call.
2. Conformance tested.
3. Localized error messages.
### Development
1. Download the code by either:
- Cloning the repository (authorised collaborators only) `git clone git@github.com:LearningLocker/xapi-validation.git`.
- [Forking the repository](https://help.github.com/articles/fork-a-repo/) and cloning the fork.
1. Change to the directory of the cloned code `cd xapi-validation`.
1. Install dependencies `npm install`.
1. Make your changes to the "src" directory.
1. Build the code `npm run build`.
1. Test the code `npm test`.
1. Commit and push your changes `npm run acp`.
1. [Create a pull request](https://help.github.com/articles/about-pull-requests/).

0 comments on commit fd4a0f1

Please sign in to comment.