@lessondesk/marker-protocol

@lessondesk/marker-protocol

Lesson Desk Marker Protocol

Table of Contents

• @lessondesk/marker-protocol
  • Table of Contents
  • Docs
  • Usage
  • Install
  • Contribute

Docs

A document regarding a full technical breakdown on how the Lesson Desk v3 marker protocol works is included in the docs directory.

Usage

import MarkerProtocol from '@lessondesk/marker-protocol'

const markers = new MarkerProtocol()

markers.on('data', packet => console.log(packet))

Install

This project uses node and npm.

$ npm install @lessondesk/marker-protocol
$ # OR
$ yarn add @lessondesk/marker-protocol

Contribute

1. Fork it and create your feature branch: git checkout -b my-new-feature
2. Test your code changes with npm run test
3. Commit your changes: git commit -am "Add some feature"
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request