Skip to content

Commit aa70529

Browse files
committed
Mention boltkit in README
1 parent 2a42f68 commit aa70529

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ We build a special browser version of the driver, which supports connecting to N
5050
This will make a global `neo4j` object available, where you can access the `v1` API at `neo4j.v1`:
5151

5252
```javascript
53-
var driver = neo4j.driver("bolt://localhost", neo4j.auth.basic("username", "password"));
53+
var driver = neo4j.driver("bolt://localhost", neo4j.auth.basic("neo4j", "neo4j"));
5454
```
5555

5656
It is not required to explicitly close the driver on a web page. Web browser should gracefully close all open
@@ -67,7 +67,7 @@ Driver creation:
6767
```javascript
6868
// Create a driver instance, for the user neo4j with password neo4j.
6969
// It should be enough to have a single driver per database per application.
70-
var driver = neo4j.driver("bolt://localhost", neo4j.auth.basic("username", "password"));
70+
var driver = neo4j.driver("bolt://localhost", neo4j.auth.basic("neo4j", "neo4j"));
7171

7272
// Register a callback to know if driver creation was successful:
7373
driver.onCompleted = function () {
@@ -126,7 +126,7 @@ Transaction functions API:
126126
// Transaction functions provide a convenient API with minimal boilerplate and
127127
// retries on network fluctuations and transient errors. Maximum retry time is
128128
// configured on the driver level and is 30 seconds by default:
129-
neo4j.driver("bolt://localhost", neo4j.auth.basic("username", "password"), {maxTransactionRetryTime: 30000});
129+
neo4j.driver("bolt://localhost", neo4j.auth.basic("neo4j", "neo4j"), {maxTransactionRetryTime: 30000});
130130

131131
// It is possible to execute read transactions that will benefit from automatic
132132
// retries on both single instance ('bolt' URI scheme) and Causal Cluster
@@ -224,10 +224,19 @@ See files under `examples/` on how to use.
224224

225225
## Testing
226226

227+
Tests **require** latest [Boltkit](https://github.com/neo4j-contrib/boltkit) to be installed in the system. It is needed to start, stop and configure local test database. Boltkit can be installed with the following command:
228+
229+
pip install --upgrade boltkit
230+
231+
To run tests against "default" Neo4j version:
232+
227233
./runTests.sh
234+
235+
To run tests against specified Neo4j version (latest enterprise 3.2 snapshot in this case):
236+
237+
./runTests.sh '-e 3.2'
228238

229-
This runs the test suite against a fresh download of Neo4j.
230-
Or `npm test` if you already have a running version of a compatible Neo4j server.
239+
Simple `npm test` can also be used if you already have a running version of a compatible Neo4j server.
231240

232241
For development, you can have the build tool rerun the tests each time you change
233242
the source code:

0 commit comments

Comments
 (0)