bijous/README.md

# Bijous


[![Build Status](https://travis-ci.org/mbrio/bijous.svg?branch=master)](https://travis-ci.org/mbrio/bijous) [![Dependency Status](https://gemnasium.com/mbrio/bijous.svg)](https://gemnasium.com/mbrio/bijous) [![Code Climate](https://codeclimate.com/github/mbrio/bijous/coverage.png)](https://codeclimate.com/github/mbrio/bijous)

[![NPM Status](https://nodei.co/npm/bijous.png?downloads=true)](https://npmjs.org/package/bijous)

An asynchronous module loader. Searches out modules within a file system using
[Klect](https://github.com/awnist/klect) and supplies an asynchronous means of
initializing them. Initialized modules may provide a service that can be used by
other modules and is made available to external code after loading has
completed.

## Installation

You can use this node module in your project by executing the following:

```Shell
$ npm install bijous
```

or by saving it to your *package.json* file:

```Shell
$ npm install --save bijous
```

In order to build, test, or generate documentation you must have gulp installed:

```Shell
$ npm install -g gulp
```

## Building

```Shell
$ npm install && gulp build
```

## Testing

```Shell
$ npm install && gulp test
```

## Documentation

```Shell
$ npm install && gulp docs
```

Once the documentation is built you can open the *index.html* within the *docs*
directory.

You can see the latest API documentation at http://mbrio.github.io/bijous.

## License

[ICS](http://opensource.org/licenses/ISC) © 2014 Michael Diolosa
<michael.diolosa@gmail.com>