jasmine-spec-factory/README.md

An opinionated Jasmine spec generator for AMD modules.

Jasmine Spec Factory
====================
[![npm Version][NPM VERSION BADGE]][NPM PAGE]
[![GitHub License][LICENSE BADGE]][LICENSE PAGE]
[![Build Status][BUILD BADGE]][BUILD PAGE]

An opinionated Jasmine spec generator for AMD modules.

Installation
------------
```sh
$ npm install --global jasmine-spec-factory
```

Usage
-----
```sh
$ jasmine-spec-factory ~/path/to/an/amd/module.js
```

Testing
-------
```sh
$ npm test
```

Opinions
--------
- Modules are AMD.
- All public methods are properties assigned to a variable named `publicMembers` which is an object returned from the module.
- All property names are enclosed in double quotes.

Issues
------
- Module name generation requires it to be documented via [JSDoc's](http://usejsdoc.org/) [`@exports`](http://usejsdoc.org/tags-exports.html) tag.

License
-------
The MIT License (Expat). See the [license file](LICENSE) for details.

[BUILD BADGE]: https://img.shields.io/travis/jbenner-radham/jasmine-spec-factory.svg?style=flat-square
[BUILD PAGE]: https://travis-ci.org/jbenner-radham/jasmine-spec-factory
[LICENSE BADGE]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
[LICENSE PAGE]: https://github.com/jbenner-radham/jasmine-spec-factory/blob/master/LICENSE
[NPM PAGE]: https://www.npmjs.com/package/jasmine-spec-factory
[NPM VERSION BADGE]: https://img.shields.io/npm/v/jasmine-spec-factory.svg?style=flat-square