diff --git a/README.md b/README.md index 58cff52..f60c612 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,9 @@ A simple validator and parser for SCO zip files written in [node](http://nodejs. ## Usage var params = { - pathToScoZip: 'testFiles/unpackScoZipTests/articulate_sco_with_quiz.zip', - pathToExtractZip: 'testFiles/unpackScoZipTests/extractFolder' - } + pathToScoZip: 'testFiles/unpackScoZipTests/articulate_sco_with_quiz.zip', + pathToExtractZip: 'testFiles/unpackScoZipTests/extractFolder' + } // initialize the parser var scoParser = require('sco-parser')(params); @@ -28,20 +28,20 @@ A simple validator and parser for SCO zip files written in [node](http://nodejs. Initialize the parser. -'pathToScoZip' - location to find the scorm package (zip file) +`pathToScoZip` - location to find the scorm package (zip file) -'pathToExtractZip' - location to unpack the scorm package to +`pathToExtractZip` - location to unpack the scorm package to ## Methods -'validate' - validates that a scorm package (.zip) contains an imsmanifest.xml +`validate` - validates that a scorm package (.zip) contains an imsmanifest.xml -'parse' - returns basic information about the scorm package +`parse` - returns basic information about the scorm package - scoHtmlHref // filename which is the entry point to the sco - quizCount // number of quizzes found in the sco + scoHtmlHref // filename which is the entry point to the sco + quizCount // number of quizzes found in the sco -'destroy' - cleans up temp files +`destroy` - cleans up temp files ## License