Skip to content
This repository has been archived by the owner on Nov 20, 2018. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@pauliejes
pauliejes committed Jun 2, 2016
1 parent 49df22d commit a18d4e8
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
View file
Expand Up @@ -4,6 +4,11 @@ Experience API Client Examples
Prototypes created for the original BAA effort, includes a Statement viewer,
Reporting example, and Tetris game example.

The xAPI client examples are built from the original Tin Can examples from Rustici Software that now implement ADL's [xAPIWrapper](https://github.com/adlnet/xAPIWrapper).

The examples are split into two folders, .95 for data compliant to the .95 xAPI specification and 1.0 for data compliant to the current 1.0.1 spec. Read more about the Experience API Spec [here](https://github.com/adlnet/xAPI-Spec/blob/master/xAPI.md).


### 0.95/
Contains examples based on the 0.95 version of the Experience API Specification

Expand Down Expand Up @@ -53,15 +58,6 @@ example since the LRS Oauth2 module only supports callback URLs.

*NOTE: For all OAuth examples, you'll need to install the python libs in each respective requirements.txt file.*

## Contributing to the project
We welcome contributions to this project. Fork this repository,
make changes and submit pull requests. If you're not comfortable
with editing the code, please submit an issue and we'll be happy
to address it.

The xAPI client examples are built from the original Tin Can examples from Rustici Software that now implement ADL's [xAPIWrapper](https://github.com/adlnet/xAPIWrapper).
The examples are split into two folders, .95 for data compliant to the .95 xAPI specification and 1.0 for data compliant to the current 1.0.1 spec. Read more about the Experience API Spec [here](https://github.com/adlnet/xAPI-Spec/blob/master/xAPI.md).

## Configuration
The 0.95 and 1.0 folders each contain a config.js.template. It is used to configure the LRS endpoint and user information. To use, rename the file to just config.js.

Expand Down Expand Up @@ -95,6 +91,11 @@ grunt connect:v095:keepalive
grunt connect:v100:keepalive
```

## Contributing to the project
We welcome contributions to this project. Fork this repository,
make changes and submit pull requests. If you're not comfortable
with editing the code, please submit an issue and we'll be happy
to address it.

## License
Copyright ©2016 Advanced Distributed Learning
Expand Down

0 comments on commit a18d4e8

Please sign in to comment.