Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 1.38 KB

module_RM_template.md

File metadata and controls

42 lines (28 loc) · 1.38 KB

[Module Name Here]

Code of Conduct

Driver for the [module name here] module. The hardware documentation can be found [here](link to module hardware documentation).

[Describe what the module does and how it can be used.]

Installation

npm install module-package-name-here

Example

/*********************************************
This [module-name] module example [describe what the example code is doing].
*********************************************/

const tessel = require('tessel');
const moduleLib = require('../'); // Replace '../' with 'module-name-here' in your own code

var module = moduleLib.use(tessel.port['A']);

// example usage of the module API

Methods

# [module].[methodName]( callback(err) )
[Describe the use of the method]

Events

# [module].on( [event], callback(err) )
Emitted upon [when is the event emitted].

Further Examples

  • [Example Code](Link to additional example code in the repo if available). [Describe the usage of the additional example code]

License

MIT or Apache 2.0, at your option