specify-core/README.md

Describe, structure and runs tests for the Specify framework.

specify-core
============

[![Build status](https://img.shields.io/travis/origamitower/specify-core/master.svg?style=flat)](https://travis-ci.org/origamitower/specify-core)
[![NPM version](https://img.shields.io/npm/v/specify-core.svg?style=flat)](https://npmjs.org/package/specify-core)
[![Dependencies status](https://img.shields.io/david/origamitower/specify-core.svg?style=flat)](https://david-dm.org/origamitower/specify-core)
![Licence](https://img.shields.io/npm/l/specify-core.svg?style=flat&label=licence)
![Stable API](https://img.shields.io/badge/API_stability-stable-green.svg?style=flat)

This module provides the basic functionality for describing, structuring, and
running tests in [Specify][]. A DSL for Sweet.js and an EDSL for plain
JavaScript are also provided.


## Installation

```shell
$ npm install specify-core
```


## Tests

```shell
$ npm install           # to make sure you've got all deps in place
$ make test
```


## Documentation

```shell
$ npm install           # to make sure you've got all deps in place
$ make documentation
$ open docs/api/index.html
```


## Licence

Copyright (c) 2013-2014 [Origami Tower](http://www.origamitower.com).

This module is part of the [Specify framework][Specify], and released under the
[MIT](http://origami-tower.mit-license.org/) licence.

[Specify]: https://github.com/origamitower/specify