ADD: Support for Ganglion full parse support

Author: AJ Keller

Diff for: changelog.md renamed to CHANGELOG.md

@@ -101,7 +101,7 @@
 
 ### New Functions
 
-* Add function `getFirmware(dataBuffer)` to utilities 
+* Add function `getFirmware(dataBuffer)` to utilities
 
 ### Breaking Changes
 
@@ -139,7 +139,7 @@
 ### New Features
 
 * In openBCIUtilities.js add function `transformRawDataPacketToSample` to parse a single raw data packet
-* In openBCIConstants.js add function `rawDataToSampleObjectDefault(numChannels)` which should be used by drivers to create the object that is passed through each call to `transformRawDataPacketsToSample` 
+* In openBCIConstants.js add function `rawDataToSampleObjectDefault(numChannels)` which should be used by drivers to create the object that is passed through each call to `transformRawDataPacketsToSample`
 
 # v0.0.6
 

Diff for: CODE_OF_CONDUCT.md

@@ -0,0 +1,69 @@
+# OpenBCI JavaScript Utilities Library Code of Conduct
+
+## Purpose
+
+It is our hope that any one is able to contribute to OpenBCI JavaScript Utilities Library regardless of their background. Thus, we hope to provide a safe, welcoming, and warmly geeky environment for everybody, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof).
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [[email protected]](mailto:[email protected]). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

Diff for: CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Contributing
+
+:tada::clinking_glasses:  First off, thanks for taking the time to contribute! :tada::clinking_glasses:
+
+Contributions are always welcome, no matter how small.
+
+The following is a small set of guidelines for how to contribute to the project
+
+## Where to start
+
+### Code of Conduct
+This project adheres to the Contributor Covenant [Code of Conduct](CODE_OF_CONDUCT.md).
+By participating you are expected to adhere to these expectations. Please report unacceptable behaviour to [[email protected]](mailto:[email protected])
+
+### Contributing on Github
+
+If you're new to Git and want to learn how to fork this repo, make your own additions, and include those additions in the master version of this project, check out this [great tutorial](http://blog.davidecoppola.com/2016/11/howto-contribute-to-open-source-project-on-github/).
+
+### Community
+
+This project is maintained by the [OpenBCI](www.openbci.com) and [NeuroTechX](www.neurotechx.com) community. Join the NeuroTechX Slack to check out our #devices channel, where discussions about OpenBCI takes place.
+
+## How can I contribute?
+
+This is currently a small, humble project so our contribution process is rather casual. Take a look at our [GitHub Projects board to see](https://github.com/NeuroTechX/eeg-101/projects) to see all the features we are currently working on. If there's a feature you'd be interested in building, go ahead! Let us know on the #interactive-tutorial channel on [the NeuroTechX Slack](http://neurotechx.herokuapp.com/) and we'll support you as much as we can. When you're finished submit a pull request to the master branch referencing the specific issue you addressed.
+
+If you find a bug, or have a suggestion on how to improve the project, just fill out a [Github issue](../../issues)

Diff for: README.md

@@ -1,24 +1,149 @@
+# OpenBCI JavaScript Utilities Library
+
+<p align="center">
+  <img alt="banner" src="/images/node_icon2.png/" width="300">
+</p>
+<p align="center" href="">
+  Provide a stable javascript library for OpenBCI
+</p>
+
 [![Build Status](https://travis-ci.org/OpenBCI/OpenBCI_NodeJS_Utilities.svg?branch=master)](https://travis-ci.org/OpenBCI/OpenBCI_NodeJS_Utilities)
 [![codecov](https://codecov.io/gh/OpenBCI/OpenBCI_NodeJS_Utilities/branch/master/graph/badge.svg)](https://codecov.io/gh/OpenBCI/OpenBCI_NodeJS_Utilities)
 [![Dependency Status](https://david-dm.org/OpenBCI/OpenBCI_NodeJS_Utilities.svg)](https://david-dm.org/OpenBCI/OpenBCI_NodeJS_Utilities)
 [![npm](https://img.shields.io/npm/dm/openbci-ganglion.svg?maxAge=2592000)](http://npmjs.com/package/openbci-utilities)
 [![js-semistandard-style](https://img.shields.io/badge/code%20style-semistandard-brightgreen.svg?style=flat-square)](https://github.com/Flet/semistandard)
 
-# OpenBCI Node.js Utilities
+## Welcome!
+
+First and foremost, Welcome! :tada: Willkommen! :confetti_ball: Bienvenue! :balloon::balloon::balloon:
+
+Thank you for visiting the OpenBCI JavaScript Utilities Library repository.
+
+This document (the README file) is a hub to give you some information about the project. Jump straight to one of the sections below, or just scroll down to find out more.
+
+* [What are we doing? (And why?)](#what-are-we-doing)
+* [Who are we?](#who-are-we)
+* [What do we need?](#what-do-we-need)
+* [How can you get involved?](#get-involved)
+* [Get in touch](#contact-us)
+* [Find out more](#find-out-more)
+* [Understand the jargon](#glossary)
+
+## What are we doing?
+
+### The problem
+
+* The first javascript libraries for OpenBCI was the [NodeJS Cyton SDK][link_nodejs], then the [NodeJS Ganglion SDK][link_nodejs_ganglion], then the [NodeJS for WiFi][link_nodejs_wifi], each with their own interfaces, serial, bluetooth, and wifi respectively.
+* The ganglion's raw data is incredibly complex and must be decompressed and carefully parsed, in less words, it takes time to learn to parse this stream
+* People want to use the [Ganglion][link_shop_ganglion] in the web browser
+
+So, if even developers are interested in working with [OpenBCI][link_shop_openbci] devices with javascript, they have a huge burden to overcome before they can parse the data.
+
+### The solution
+
+The OpenBCI JavaScript Utilities Library will:
+
+* Provide a nice cozy home to all the horror of parsing raw binary byte streams
+* Use automated testing extensively and don't let untested code be released!
+* Work in the browser and NodeJS!
+* Be able to parse ganglion and cyton data.
+* Store a constants file so every module agrees on names of keys and such
+
+Using a single unified JavaScript library solves the challenges of parsing raw brainwave data. Our main goal is to ***provide a stable javascript library for OpenBCI***
+
+## Who are we?
+
+The main code writer of the OpenBCI JavaScript Utilities Library is [AJ Keller][link_aj_keller]. This code all started in the OpenBCI NodeJS SDK for Cyton. Many people contributed, if not directly, but by advice or instructions drawn on a coffee table to calculate impedance. A lot of people who use this library never have any idea about it! Every user of the OpenBCI GUI is heavily dependent on this code base for all data acquisition from the Cyton, Ganglion and WiFi shield!
+
+## What do we need?
+
+**You**! In whatever way you can help.
+
+We need expertise in programming, user experience, software sustainability, documentation and technical writing and project management.
+
+We'd love your feedback along the way.
+
+Our primary goal is to provide a stable javascript library for OpenBCI, and we're excited to support the professional development of any and all of our contributors. If you're looking to learn to code, try out working collaboratively, or translate you skills to the digital domain, we're here to help.
+
+## Get involved
+
+If you think you can help in any of the areas listed above (and we bet you can) or in any of the many areas that we haven't yet thought of (and here we're *sure* you can) then please check out our [contributors' guidelines](CONTRIBUTING.md) and our [roadmap](ROADMAP.md).
+
+Please note that it's very important to us that we maintain a positive and supportive environment for everyone who wants to participate. When you join us we ask that you follow our [code of conduct](CODE_OF_CONDUCT.md) in all interactions both on and offline.
 
-A Node.js module for OpenBCI ~ written with love by [Push The World!](http://www.pushtheworldllc.com)
+## Contact us
 
-Push The World is actively developing and maintaining this module.
+If you want to report a problem or suggest an enhancement we'd love for you to [open an issue](../../issues) at this github repository because then we can get right on it. But you can also contact [AJ][link_aj_keller] by email (pushtheworldllc AT gmail DOT com) or on [twitter](https://twitter.com/aj-ptw).
 
-The purpose of this module is to supply a common node core that allows the reuse of mission critical components, such as sending commands or using a simulator.
+## Find out more
+
+You might be interested in:
+
+* What is [OpenBCI][link_openbci]?
+
+And of course, you'll want to know our:
+
+* [Contributors' guidelines](CONTRIBUTING.md)
+* [Roadmap](ROADMAP.md)
+
+## Thank you
+
+Thank you so much (Danke schön! Merci beaucoup!) for visiting the project and we do hope that you'll join us on this amazing journey to make programming with OpenBCI fun and easy.
+
+# Documentation
 
 ### Table of Contents:
 ---
 
-1. [Developing](#developing)
-2. [Testing](#developing-testing)
-3. [Contribute](#contribute)
-4. [License](#license)
+1. [Installation](#install)
+2. [Usage](#usage)
+2. [Developing](#developing)
+3. [Testing](#developing-testing)
+4. [Contribute](#contribute)
+5. [License](#license)
+
+## <a name="install"></a> Installation:
+
+```
+npm install openbci-utilities
+```
+
+## <a name="usage"></a> Usage:
+
+### In NodeJS
+
+```node
+const { constants, debug, utilities } = require('openbci-utilities');
+
+console.log('OpenBCIUtilities', OpenBCIUtilities);
+```
+
+### In Web Browser
+
+**index.html**
+
+```html
+<!doctype html>
+<html>
+    <head>
+        <meta charset="UTF-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <meta http-equiv="X-UA-Compatible" content="ie=edge">
+        <title>OpenBCI Utilities</title>
+    </head>
+    <body>
+        <pre>See data in the console</pre>
+        <script src="../../dist/openbci-utilities.var.js"></script>
+        <script src="./index.js"></script>
+    </body>
+</html>
+```
+
+**index.js**
+
+```javascript
+console.log(OpenBCIUtilities);
+```
 
 
 ## <a name="developing"></a> Developing:
@@ -49,3 +174,19 @@ npm test
 ## <a name="license"></a> License:
 
 MIT
+
+[link_aj_keller]: https://github.com/aj-ptw
+[link_shop_wifi_shield]: https://shop.openbci.com/collections/frontpage/products/wifi-shield?variant=44534009550
+[link_shop_ganglion]: https://shop.openbci.com/collections/frontpage/products/pre-order-ganglion-board
+[link_shop_cyton]: https://shop.openbci.com/collections/frontpage/products/cyton-biosensing-board-8-channel
+[link_shop_cyton_daisy]: https://shop.openbci.com/collections/frontpage/products/cyton-daisy-biosensing-boards-16-channel
+[link_nodejs]: https://github.com/OpenBCI/OpenBCI_NodeJS
+[link_nodejs_cyton]: https://github.com/OpenBCI/OpenBCI_NodeJS_Cyton
+[link_nodejs_ganglion]: https://github.com/OpenBCI/OpenBCI_NodeJS_Ganglion
+[link_nodejs_wifi]: https://github.com/OpenBCI/OpenBCI_NodeJS_Wifi
+[link_ptw]: https://www.pushtheworldllc.com
+[link_openbci]: http://www.openbci.com
+[link_mozwow]: http://mozillascience.github.io/working-open-workshop/index.html
+[link_wifi_get_streaming]: examples/getStreaming/getStreaming.js
+[link_openleaderscohort]: https://medium.com/@MozOpenLeaders
+[link_mozsci]: https://science.mozilla.org

Diff for: ROADMAP.md

@@ -0,0 +1,14 @@
+# Roadmap
+
+## OpenBCI JavaScript Utilities Library
+
+Provide a stable javascript library for OpenBCI
+
+## Short term - what we're working on now
+
+- Unit tests!
+- Documentation for public functions
+
+## Medium term
+
+- Examples