Skip to content

Commit c83c6ff

Browse files
authored
Merge pull request #55 from daniellasry/master
DOCS: updated readme with @openbci/ganglion
2 parents 4821b36 + affde14 commit c83c6ff

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
[![Build Status](https://travis-ci.org/OpenBCI/OpenBCI_NodeJS_Ganglion.svg?branch=master)](https://travis-ci.org/OpenBCI/OpenBCI_NodeJS_Ganglion)
33
[![codecov](https://codecov.io/gh/OpenBCI/OpenBCI_NodeJS_Ganglion/branch/master/graph/badge.svg)](https://codecov.io/gh/OpenBCI/OpenBCI_NodeJS_Ganglion)
44
[![Dependency Status](https://david-dm.org/OpenBCI/OpenBCI_NodeJS_Ganglion.svg)](https://david-dm.org/OpenBCI/OpenBCI_NodeJS_Ganglion)
5-
[![npm](https://img.shields.io/npm/dm/openbci-ganglion.svg?maxAge=2592000)](http://npmjs.com/package/openbci-ganglion)
5+
[![npm](https://img.shields.io/npm/dm/@openbci/ganglion.svg?maxAge=2592000)](http://npmjs.com/package/@openbci/ganglion)
66

77
# OpenBCI Node.js Ganglion SDK
88

@@ -35,7 +35,7 @@ The purpose of this module is to **get connected** and **start streaming** as fa
3535
Get connected and start streaming right now
3636

3737
```js
38-
const Ganglion = require("openbci-ganglion");
38+
const Ganglion = require("@openbci/ganglion");
3939
const ganglion = new Ganglion();
4040
ganglion.once("ganglionFound", peripheral => {
4141
// Stop searching for BLE devices once a ganglion is found.
@@ -122,14 +122,14 @@ Check out the [**_automatic_** tests](https://codecov.io/gh/OpenBCI/OpenBCI_Node
122122
Initializing the board:
123123

124124
```js
125-
const Ganglion = require("openbci-ganglion");
125+
const Ganglion = require("@openbci/ganglion");
126126
const ganglion = new Ganglion();
127127
```
128128

129129
For initializing with options, such as verbose print outs:
130130

131131
```js
132-
const Ganglion = require("openbci-ganglion");
132+
const Ganglion = require("@openbci/ganglion");
133133
const ourBoard = new Ganglion({
134134
verbose: true
135135
});
@@ -138,7 +138,7 @@ const ourBoard = new Ganglion({
138138
For initializing with callback, such as to catch errors on `noble` startup:
139139

140140
```js
141-
const Ganglion = require("openbci-ganglion");
141+
const Ganglion = require("@openbci/ganglion");
142142
const ourBoard = new Ganglion(error => {
143143
if (error) {
144144
console.log("error", error);
@@ -151,7 +151,7 @@ const ourBoard = new Ganglion(error => {
151151
For initializing with options and callback, such as verbose and to catch errors on `noble` startup:
152152

153153
```js
154-
const Ganglion = require("openbci-ganglion");
154+
const Ganglion = require("@openbci/ganglion");
155155
const ourBoard = new Ganglion(
156156
{
157157
verbose: true
@@ -172,7 +172,7 @@ You MUST wait for the 'ready' event to be emitted before streaming/talking with
172172
so installing the 'sample' listener and writing before the ready event might result in... nothing at all.
173173

174174
```js
175-
const Ganglion = require("openbci-ganglion");
175+
const Ganglion = require("@openbci/ganglion");
176176
const ourBoard = new Ganglion();
177177
ourBoard
178178
.connect(portName)
@@ -203,7 +203,7 @@ The power of this module is in using the sample emitter, to be provided with sam
203203
4. Install the ['sample'](#event-sample) event emitter
204204

205205
```js
206-
const Ganglion = require("openbci-ganglion");
206+
const Ganglion = require("@openbci/ganglion");
207207
const ourBoard = new Ganglion();
208208
ourBoard
209209
.connect(localName)
@@ -223,7 +223,7 @@ ourBoard
223223
Close the connection with [`.streamStop()`](#method-stream-stop) and disconnect with [`.disconnect()`](#method-disconnect)
224224

225225
```js
226-
const Ganglion = require("openbci-ganglion");
226+
const Ganglion = require("@openbci/ganglion");
227227
const ourBoard = new Ganglion();
228228
ourBoard.streamStop().then(ourBoard.disconnect());
229229
```

examples/labstreaminglayer/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ If you would like to use lab streaming layer in a custom OpenBCI NodeJS applicat
4848

4949
index.js
5050
```js
51-
const Ganglion = require('openbci-ganglion').Ganglion;
51+
const Ganglion = require('@openbci/ganglion').Ganglion;
5252
var portPub = 'tcp://127.0.0.1:3004';
5353
var zmq = require('zmq-prebuilt');
5454
var socket = zmq.socket('pair');

0 commit comments

Comments
 (0)