28 lines (15 loc) · 637 Bytes

GroundSource jquery-api-wrapper

a jquery wrapper for the GroundSource API.

Project structure

/docs/ - API documentation (generated by jsdoc)
/examples/ - working examples, with relative paths to local libs
/script/ - location of all js library files
/test/ - project unit tests, using QUnit

Required Dependencies

jQuery -- tested and works with nearly all versions of jQuery (fully tested against 1.4 - 1.11, 2.1)

development commands

generate docs

	$ brew install jsdoc3
	$ jsdoc script/* -d docs

run unit tests

navigate to /test/ directory of project on localhost