Skip to content

Latest commit

 

History

History
26 lines (17 loc) · 1.29 KB

README.md

File metadata and controls

26 lines (17 loc) · 1.29 KB

incubator

Interested in contributing to OpenSocial open source projects? View CONTRIBUTING.md for details.

Components

Pump.io

If you are using Pump.io to prototype, then please read README-pump.io.md

Building Docs

This project is fully documented using JSDoc 3.

To build the documentation you can run the provided script. You will need to have the jsdoc command installed globally first.

$ buildDoc.sh

or you can alternatively run

$ jsdoc -c jsdoc.conf

Visit https://github.com/jsdoc3/jsdoc for more information about using JSDoc 3.