LiveScript
Switch branches/tags
Nothing to show
Latest commit efe8e3f Dec 24, 2013 @robotlolita robotlolita Fixes chain()
Permalink
Failed to load latest commit information.
src
test
tools
.gitignore
.hgignore
.npmignore
.travis.yml
LICENCE
Makefile
README.md
package.json

README.md

data.persistent

Build Status NPM version Dependencies Status experimental

Algebraic instances for ClojureScript's functional data structures (Mori)

Example

( ... )

Installing

The easiest way is to grab it from NPM. If you're running in a Browser environment, you can use Browserify

$ npm install data.persistent

Using with CommonJS

If you're not using NPM, Download the latest release, and require the data.persistent.umd.js file:

var persistent = require('data.persistent')

Using with AMD

Download the latest release, and require the data.persistent.umd.js file:

require(['data.persistent'], function(persistent) {
  ( ... )
})

Using without modules

Download the latest release, and load the data.persistent.umd.js file. The properties are exposed in the global folktale.data.persistent object:

<script src="/path/to/data.persistent.umd.js"></script>

Compiling from source

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

$ git clone git://github.com/folktale/data.persistent.git
$ cd data.persistent
$ npm install
$ make bundle

This will generate the dist/data.persistent.umd.js file, which you can load in any JavaScript environment.

Documentation

You can read the documentation online or build it yourself:

$ git clone git://github.com/folktale/data.persistent.git
$ cd data.persistent
$ npm install
$ make documentation

Then open the file docs/literate/index.html in your browser.

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.