Skip to content

Commit 0da1d5e

Browse files
updated readme (#597)
1 parent 7eb9815 commit 0da1d5e

File tree

1 file changed

+27
-15
lines changed

1 file changed

+27
-15
lines changed

README.md

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ This is the official Neo4j driver for JavaScript.
44

55
Resources to get you started:
66

7-
- Detailed docs _Not available yet_
7+
- [API Documentation](https://neo4j.com/docs/api/javascript-driver/4.1/)
88
- [Neo4j Manual](https://neo4j.com/docs/)
99
- [Neo4j Refcard](https://neo4j.com/docs/cypher-refcard/current/)
1010

1111
## What's New in 4.1
1212

13-
- TODO
13+
- [Changelog](https://github.com/neo4j/neo4j-javascript-driver/wiki/4.1-changelog)
1414

1515
## Including the Driver
1616

@@ -63,12 +63,12 @@ It can be included in an HTML page using one of the following tags:
6363
<script src="https://cdn.jsdelivr.net/npm/[email protected]/lib/browser/neo4j-web.min.js"></script>
6464
```
6565

66-
This will make a global `neo4j` object available, where you can access the driver API at `neo4j`\*:
66+
This will make a global `neo4j` object available, where you can create a driver instance with `neo4j.driver`:
6767

6868
```javascript
6969
var driver = neo4j.driver(
7070
'neo4j://localhost',
71-
neo4j.auth.basic('neo4j', 'neo4j')
71+
neo4j.auth.basic('neo4j', 'password')
7272
)
7373
```
7474

@@ -85,11 +85,11 @@ driver.close() // returns a Promise
8585
### Constructing a Driver
8686

8787
```javascript
88-
// Create a driver instance, for the user neo4j with password neo4j.
88+
// Create a driver instance, for the user `neo4j` with password `password`.
8989
// It should be enough to have a single driver per database per application.
9090
var driver = neo4j.driver(
9191
'neo4j://localhost',
92-
neo4j.auth.basic('neo4j', 'neo4j')
92+
neo4j.auth.basic('neo4j', 'password')
9393
)
9494

9595
// Close the driver when application exits.
@@ -238,7 +238,7 @@ rxSession
238238
// retries on network fluctuations and transient errors. Maximum retry time is
239239
// configured on the driver level and is 30 seconds by default:
240240
// Applies both to standard and reactive sessions.
241-
neo4j.driver('neo4j://localhost', neo4j.auth.basic('neo4j', 'neo4j'), {
241+
neo4j.driver('neo4j://localhost', neo4j.auth.basic('neo4j', 'password'), {
242242
maxTransactionRetryTime: 30000
243243
})
244244
```
@@ -472,15 +472,17 @@ To enable potentially lossy integer values use the driver's configuration object
472472
```javascript
473473
var driver = neo4j.driver(
474474
'neo4j://localhost',
475-
neo4j.auth.basic('neo4j', 'neo4j'),
475+
neo4j.auth.basic('neo4j', 'password'),
476476
{ disableLosslessIntegers: true }
477477
)
478478
```
479479

480480
## Building
481481

482-
npm install
483-
npm run build
482+
```
483+
npm install
484+
npm run build
485+
```
484486

485487
This produces browser-compatible standalone files under `lib/browser` and a Node.js module version under `lib/`.
486488
See files under `examples/` on how to use.
@@ -491,26 +493,36 @@ Tests **require** latest [Boltkit](https://github.com/neo4j-contrib/boltkit) and
491493

492494
Boltkit is needed to start, stop and configure local test database. Boltkit can be installed with the following command:
493495

494-
pip3 install --upgrade boltkit
496+
```
497+
pip3 install --upgrade boltkit
498+
```
495499

496500
To run tests against "default" Neo4j version:
497501

498-
./runTests.sh
502+
```
503+
./runTests.sh
504+
```
499505

500506
To run tests against specified Neo4j version:
501507

502-
./runTests.sh '-e 4.1.0'
508+
```
509+
./runTests.sh '-e 4.1.0'
510+
```
503511

504512
Simple `npm test` can also be used if you already have a running version of a compatible Neo4j server.
505513

506514
For development, you can have the build tool rerun the tests each time you change
507515
the source code:
508516

509-
gulp watch-n-test
517+
```
518+
gulp watch-n-test
519+
```
510520

511521
If the `gulp` command line tool is not available, you might need to install this globally:
512522

513-
npm install -g gulp-cli
523+
```
524+
npm install -g gulp-cli
525+
```
514526

515527
### Testing on windows
516528

0 commit comments

Comments
 (0)