mph
v0.0.1
Published
Mph.
Downloads
17
Readme
Mph
Mph.
###Install
$ npm install mph [-g]
require:
var Mph = require( 'mph' );
###Run Tests
to run all test files, install devDependecies:
$ cd mph/
# install or update devDependecies
$ npm install
# run tests
$ npm test
to execute a single test file simply do:
$ node test/file-name.js
###Constructor
Mph( [ Object opt ] )
// or
new Mph( [ Object opt ] )
####Options
Default options are listed.
opt = {
}
###Properties
/*
* Instance configuration object.
*/
Mph.options : Object
###Methods
Arguments within [ ] are optional.
/*
*/
Mph#do : function () : Mph
MIT License
Copyright (c) 2015 < Guglielmo Ferri : [email protected] >
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.