once-upon-a-time v0.1.5-alpha

Once upon a time...

An algebraic prelude for LiveScript (and JavaScript). Compatible with fantasy-land.

Example

( ... )

Installing

The easiest way is to grab it from NPM (if you're in the Browser, use Browserify):

$ npm install once-upon-a-time

But I use AMD! (or CommonJS without NPM)

If you use AMD, or some implementation of CommonJS that doesn't rely on NPM, you can Download the latest release, which includes the once-upon-a-time.umd.js file, configure your tool appropriately to load the file, then:

require(["once-upon-a-time"], function(onceUponATime) {
  ...
})

But I don't use modules!

If you don't use modules, you can Download the latest release, which includes the once-upon-a-time.umd.js file, and just load the file as you would any other library. onceUponATime will be a global that you can use:

<script src="/path/to/once-upon-a-time.umd.js"></script>

Compiling from source

If you want to compile the library from the source, You'll need Git, Make and Node.js, and run the following commands:

$ git clone git://github.com/killdream/once-upon-a-time.git
$ cd once-upon-a-time
$ npm install
$ make bundle

This will generate the dist/once-upon-a-time.umd.js file, which you can include anywhere.

Documentation

You can either read it online, or generate it yourself:

$ make documentation
$ open docs/literate/index.html

Tests

$ npm install
$ make test

Platform support

This library assumes an ES5 environment, but can be easily supported in ES3 platforms by the use of shims. Just include es5-shim :)

Licence

Copyright (c) 2013 Quildreen Motta.

Released under the MIT licence.