Skip to content

Commit 5e0a72f

Browse files
committed
Update README.
1 parent 7bdbc78 commit 5e0a72f

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,25 @@
11
# Neo4j Bolt Driver for JavaScript
22

3+
An alpha-level database driver for a new Neo4j remoting protocol.
34

4-
## Example
5+
Note: This is in active development, the API is not stable. Please try it out and give us feedback, but expect things to break in the medium term!
6+
7+
## Add module to Nodejs application
58

69
```javascript
710
var neo4j = require('build/node/neo4j');
11+
```
812

13+
## Include in web browser
14+
A global object `neo4j` will be available.
15+
16+
```html
17+
<script src="build/browser/neo4j-web.min.js"></script>
18+
```
19+
20+
## Usage examples (works both in nodejs and browser environments)
21+
22+
```javascript
923
var statement = ['MERGE (alice:Person {name:{name_a},age:{age_a}})',
1024
'MERGE (bob:Person {name:{name_b},age:{age_b}})',
1125
'CREATE UNIQUE (alice)-[alice_knows_bob:KNOWS]->(bob)',

0 commit comments

Comments
 (0)