test-scribe/README.md

Your sidekick for analog machine development. Run machines interactively and generate automated test scripts based on the outcome.

# scribe

Your sidekick for analog machine development.

### Huh?

Learn more about [the Node-Machine Project](http://node-machine.org) and [Treeline](https://treeline.io).


### Who are you?

Hi!  I'm the scribe. It's nice to meet you. I help developers:

+ run machines interactively and generate automated test scripts based on the outcome.
+ visualize the APIs for their software

As you might expect, I'm also a Sails.js app.



### Usage

Install:

```sh
npm install test-scribe --save
```

Use:

```js
var Scribe = require('test-scribe');
Scribe({
  pathToPack: 'foo',
  port: 1337
}, function (err, app) {
  if (err) {
    console.error('Failed to start scribe utility.  Error details:',err);
    return;
  }

  // OK!  Scribe is running at http://localhost:1337.

})
```


> (note that if a relative path is provided for `pathToPack`, it will be resolved from the top-level directory of the directory where `scribe` is installed)


### License

© 2015, Mike McNeil, © 2015 The Treeline Company.
All rights reserved.