README.md

FeatureBook

• Introduction
• Usage
• Running Tests
• Releasing
• License

Introduction

FeatureBook is a command line tool (and Node.js library) for generating beautiful system specifications from Gherkin source files.

Here is an example system specification.

Usage

FeatureBook can be installed from npm using:

$ npm install featurebook -g

You can serve the current directory as a system specification using:

$ featurebook serve --port 3000

Or simply build the static website using:

$ featurebook build --output-dir ~/book

Running Tests

$ npm install -g bower mocha karma-cli

$ mocha --reporter spec --timeout 1500 test/lib

$ cd public && bower install && cd ..

$ karma start test/public/karma.conf.js

Releasing

Select a branch that contains the code you want to release. Usually, you'll want to release against the master branch, unless you're releasing a beta version.

Let's assume that the latest version of the featurebook package is 0.0.6 (see the version property in package.json).

$ git clone https://github.com/SOFTWARE-CLINIC/featurebook.git && cd featurebook

To bump the path|minor|major version number and write the new data back to package.json:

$ npm version patch|minor|major -m "[npm] prepare release %s"
v0.0.7

Note that this command will also create a version commit and tag named v0.0.7, and fail if the cloned repository is not clean.

To push the commit and the v0.0.7 tag to the origin repository:

$ git push -u origin master
$ git push origin v0.0.7

To publish to the public registry:

$ git checkout tags/v0.0.7
$ npm publish

License

Code is under the Apache Licence, Version 2.0.