franken v0.0.2

franken

NodeJS module for the Franken monitoring service. Franken is not yet publically available, the application and this module are currently in development.

Getting Started

Install the module with: npm install franken

Documentation

(Coming soon)

Examples

NodeJS Application

var Franken = require('franken');

var franken = new Franken({
	applicationId: '', // your unique application ID from the Franken API
	publish: {
		key: '', // a publisher key from the Franken API used for authentication
		token: '' // the token that pairs with the key above
	}
}, 'sample-app');
franken.start(); // begin sending heartbeat every 5 seconds

Release History

0.0.1

• ADDED: Added ability to enable/disable transmission from config. Useful for local/test environments

0.0.0

• ADDED: Initial Release

License

Copyright (c) 2014 Inlight Media Licensed under the MIT license.