neuro-events

The best project ever.

Getting Started

Before anything taking its part, you should install node and "cortex".

Install Node

Visit http://nodejs.org, download and install the proper version of nodejs.

Install Cortex

# maybe you should use `sudo`
npm install -g cortex

Using neuro-events In Your Project

First, install 'neuro-events' directly with ctx install (recommended)

ctx install neuro-events --save

or, you could update your package.json manually

dependencies: {
    'neuro-events': '<version-you-want>'
}

and install dependencies

ctx install

Then, use require method in your module

var neuro-events = require('neuro-events');

Finally, start cortex server

ctx server

Then cortex will care all the rest.

API Documentation

neuro-events: constructor

': constructor' means the module.exports of module 'neuro-events' is a constructor that we should use it with the new keyword

new neuro-events(options)

options

• options.name {String}

neuro-events.<method-name>(arguments)

Means this is a static method of module.exports

arguments

// arguments description here

.<method-name>(arguments)

Mean this is a method of the instance

arguments

// arguments description here