Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 1.85 KB

README.md

File metadata and controls

37 lines (28 loc) · 1.85 KB

eventify-js

A micro library built to handle JavaScript event dispatching. Does binding, unbinding, triggering and aliasing. It comes with support for CommonJS and AMD environments.

Build Status Coverage Status License Dependencies devDependency Status

Info

Make sure you have node and npm running on your machine. This tutorial uses node v0.12.4 and v2.10.1 of npm. In case you haven't installed it yet, read this to install Node and NPM

Annotated source code

I tried to keep the documentation of source code as good as possible. It will be helpful for beginners understand the simple concepts that went in developing this micro library. Documentation is available on Github Pages Eventify Documentation.

Local build setup

$ git clone https://github.com/geraldchecka/eventify.git
$ cd eventify
$ npm install
$ npm run build

To generate annotated sourcecode documentation

npm run doc

Perform unit-testing and coverage. Also generates SpecRunner & Coverage reports. They can be found under Reports folder

npm run test

License

MIT