cmpsoares91/NMAE

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# NMAE
[![GitHub version](https://badge.fury.io/gh/cmpsoares91%2Fnmae.svg)](http://badge.fury.io/gh/cmpsoares91%2Fnmae) [![npm version](https://badge.fury.io/js/nmae.svg)](http://badge.fury.io/js/nmae) [![Code Climate](https://codeclimate.com/github/cmpsoares91/NMAE/badges/gpa.svg)](https://codeclimate.com/github/cmpsoares91/NMAE) [![Test Coverage](https://codeclimate.com/github/cmpsoares91/NMAE/badges/coverage.svg)](https://codeclimate.com/github/cmpsoares91/NMAE)

The purpose of the NMAE (Node.JS Module Academic Example) project is to serve as an Academic example of a Node.JS Module implementation, making it easier for those unfamiliarized to Node.JS to understand its syntax and paradigm.

This module can also be used as a starter framework/example for those wanting to create a Node.JS module and publish it at [npmjs.com](https://www.npmjs.com/).

Resulting module package from this project is already published at [npmjs.com(NMAE)](https://www.npmjs.com/package/nmae).

## Release History

* 0.1.2 Patch to fix npm publication
* 0.1.1 Readme patch
* 0.1.0 Initial release

## Credits

  See the [contributors](https://github.com/cmpsoares91/NMAE/graphs/contributors).

  Initial contributions where made for an academic presentation, at [ISCTE-IUL](http://www.iscte-iul.pt/en/home.aspx), by:
   - [Carlos Soares](https://github.com/cmpsoares91/)
   - [José Vaz](https://github.com/JoseVaz)
   - [Nuno Salgado](https://github.com/ncsalgado)

## References

  See the [references](https://github.com/cmpsoares91/NMAE/blob/master/REFERENCES.md)

## [License](https://github.com/cmpsoares91/NMAE/blob/master/LICENSE.md)
#### Source Code
<pre>
The MIT License (MIT)

Copyright (c) 2015 Carlos Soares, José Vaz, Nuno Salgado

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.
</pre>

#### Documentation
><a rel="license" href="http://creativecommons.org/licenses/by-nc/4.0/"><img alt="Licença Creative Commons" style="border-width:0" src="https://i.creativecommons.org/l/by-nc/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">NMAE</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="https://github.com/cmpsoares91/NMAE" property="cc:attributionName" rel="cc:attributionURL">Carlos Soares, José Vaz & Nuno Salgado</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc/4.0/">Creative Commons Atribuição-Uso Não-Comercial 4.0 Internacional License</a>.<br />Based on a work at <a xmlns:dct="http://purl.org/dc/terms/" href="https://github.com/cmpsoares91/NMAE" rel="dct:source">https://github.com/cmpsoares91/NMAE</a>.<br />Permissions beyond the scope of this license may be available at <a xmlns:cc="http://creativecommons.org/ns#" href="https://github.com/cmpsoares91/NMAE/blob/master/LICENSE.md" rel="cc:morePermissions">https://github.com/cmpsoares91/NMAE/blob/master/LICENSE.md</a>.


[![Analytics](https://ga-beacon.appspot.com/UA-61026805-1/GitHub/NMAE/README.md)](https://github.com/igrigorik/ga-beacon)