README.md

OKlib

It's OK

This repository contains the SinusBot Script Library OKlib and the JSDoc based javascript file from which the documentation can be generated.

Example

Demo Script that explains how to use the OKlib

registerPlugin({
    name: 'Demo Script',
    version: '1.0',
    description: 'OKlib_Demo',
    author: 'Author <[email protected]>',
    vars: []
}, function(sinusbot, config) {
    require('event').on('load', function(){
        var lib = require('OKlib.js');
        main(lib);
    });
    function main(OKlib){
        //Your code goes here
        //use lib functions now with OKlib.functionName()
    }
});

Build

If you want to build the documentation files follow these steps

Install documentation.js

npm install -g documentation

Generate html file

documentation build api.js --project-name "OKlib" -f html -o documentation