Skip to content

Commit 983ce60

Browse files
committed
chore: update readme with authetication notes
1 parent ff8ab4a commit 983ce60

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,12 @@ const schema = require('enigma.js/schemas/12.20.0.json');
6666
// create a new session:
6767
const session = enigma.create({
6868
schema,
69+
// URL to running QIX Engine - might require additional parameters for authentication - see examples
6970
url: 'ws://localhost:9076/app/engineData',
7071
createSocket: url => new WebSocket(url),
7172
});
7273

74+
7375
// bind traffic events to log what is sent and received on the socket:
7476
session.on('traffic:sent', data => console.log('sent:', data));
7577
session.on('traffic:received', data => console.log('received:', data));
@@ -89,7 +91,7 @@ And then run it:
8991
node my-file.js
9092
```
9193

92-
You may need to adjust the code so the URL points towards your running QIX Engine.
94+
You may need to adjust the code so the URL points towards your running QIX Engine as well as handle any authentication needed.
9395

9496
![/getting-started.gif](/getting-started.gif)
9597

@@ -105,7 +107,7 @@ Create a HTML file `index.html` and insert the following example content:
105107
.then(schema => {
106108
const session = enigma.create({
107109
schema,
108-
// Change the url to point to your QIX instance
110+
// Change the url to point to your QIX instance - might require additional parameters for authentication - see examples
109111
url: 'ws://localhost:9076/app/engineData',
110112
createSocket: url => new WebSocket(url)
111113
})

0 commit comments

Comments
 (0)