diff --git a/README.md b/README.md index 9395b3f..b2411c8 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,6 @@ not supported by IE11, you will need to provide your own polyfill for this funct To begin with, you include either the `scorm-again.js` or `scorm-again.min.js` file on your launching page: ```html - ``` @@ -43,7 +42,6 @@ Or, if you would like to only pull in one API, you include either the `aicc.js`, their minified versions on your launching page: ```html - ``` @@ -62,21 +60,18 @@ yarn add scorm-again You would then initialize the APIs using the following JS statements: ```javascript -var settings = {} -# -AICC +var settings = {}; + +// AICC window.API = new AICC(settings); -# -SCORM -1.2 +// SCORM 1.2 window.API = new Scorm12API(settings); -# -SCORM -2004 +// SCORM 2004 window.API_1484_11 = new Scorm2004API(settings); ``` + ### A Note About API Discovery Before creating a ticket about your module not being able to communicate with the LMS, please make sure you've looked over my examples in the `gh-pages` branch, as well as reading the [SCORM API Discovery Algorithms](https://scorm.com/scorm-explained/technical-scorm/run-time/api-discovery-algorithms/) page. I get that some of this stuff can be hard to implement at first, but I can't give an example for every possible way this library can be loaded into your application. The main thing to remember is that it should always be attached to the `window` object, because that's where modules are supposed to look.