|
1 | 1 | # xapi-validation |
2 | | -> A package for validating xAPI Statements. |
3 | 2 |
|
| 3 | +[](https://www.npmjs.com/package/xapi-validation) |
4 | 4 | [](https://travis-ci.org/LearningLocker/xapi-validation) |
5 | | -[](https://david-dm.org/LearningLocker/xapi-validation) |
6 | | -[](https://david-dm.org/LearningLocker/xapi-validation?type=dev) |
7 | | -[](https://codecov.io/gh/LearningLocker/xapi-validation) |
| 5 | +[](https://greenkeeper.io/) |
| 6 | +[](https://github.com/semantic-release/semantic-release) |
| 7 | +[](https://gitter.im/LearningLocker/learninglocker?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
| 8 | + |
| 9 | + |
| 10 | +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). |
| 11 | + |
| 12 | +*Learning Locker is a trademark of [HT2 Inc.](http://ht2labs.com)* |
| 13 | + |
| 14 | +### Installation |
| 15 | +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. |
8 | 16 |
|
9 | 17 | ```js |
10 | | -npm install --save xapi-validation |
| 18 | +npm i xapi-validation |
11 | 19 | ``` |
12 | 20 |
|
13 | | -[Try it out on RunKit](https://runkit.com/58834fa5d14b5b0013806bde/5883507a9faa130014213d6a). |
14 | | - |
15 | | -## Why? |
16 | | -1. Find and return all of the problems with your xAPI statements in one function call. |
17 | | -2. Conformance tested. |
18 | | -3. Localized error messages. |
| 21 | +### Development |
| 22 | +1. Download the code by either: |
| 23 | + - Cloning the repository (authorised collaborators only) `git clone git@github.com:LearningLocker/xapi-validation.git`. |
| 24 | + - [Forking the repository](https://help.github.com/articles/fork-a-repo/) and cloning the fork. |
| 25 | +1. Change to the directory of the cloned code `cd xapi-validation`. |
| 26 | +1. Install dependencies `npm install`. |
| 27 | +1. Make your changes to the "src" directory. |
| 28 | +1. Build the code `npm run build`. |
| 29 | +1. Test the code `npm test`. |
| 30 | +1. Commit and push your changes `npm run acp`. |
| 31 | +1. [Create a pull request](https://help.github.com/articles/about-pull-requests/). |
0 commit comments