Skip to content

Commit 4d78393

Browse files
authored
Improve docs around packages and versions (#1054)
1 parent 28b1907 commit 4d78393

File tree

5 files changed

+8
-5
lines changed

5 files changed

+8
-5
lines changed

packages/neo4j-driver-lite/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1-
# Neo4j Driver for JavaScript
1+
# Neo4j Lite Driver for JavaScript
22

33
This is the lite version of the official Neo4j driver for JavaScript.
44

5+
This version of the driver has the same capabilities as the Neo4j Driver except for the support of reactive sessions.
6+
This means it doesn't have the `RxJS` dependency and the `Driver#rxSession` api.
7+
58
Starting with 5.0, the Neo4j Drivers will be moving to a monthly release cadence. A minor version will be released on the last Friday of each month so as to maintain versioning consistency with the core product (Neo4j DBMS) which has also moved to a monthly cadence.
69

710
As a policy, patch versions will not be released except on rare occasions. Bug fixes and updates will go into the latest minor version and users should upgrade to that. Driver upgrades within a major version will never contain breaking API changes.

packages/neo4j-driver-lite/esdoc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
"enable": false
3737
},
3838
"brand": {
39-
"title": "Neo4j Bolt Driver 4.4 for JavaScript",
39+
"title": "Neo4j Bolt Lite Driver 5.x for JavaScript",
4040
"repository": "https://github.com/neo4j/neo4j-javascript-driver"
4141
}
4242
}

packages/neo4j-driver-lite/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "neo4j-driver-lite",
33
"version": "5.0.0-dev",
4-
"description": "Connect to Neo4j 3.5.0 and up from JavaScript",
4+
"description": "The official Neo4j lite driver for Javascript",
55
"main": "lib/index.js",
66
"types": "types/index.d.ts",
77
"scripts": {

packages/neo4j-driver/esdoc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
"enable": true
3737
},
3838
"brand": {
39-
"title": "Neo4j Bolt Driver 4.4 for JavaScript",
39+
"title": "Neo4j Bolt Driver 5.x for JavaScript",
4040
"repository": "https://github.com/neo4j/neo4j-javascript-driver"
4141
}
4242
}

packages/neo4j-driver/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "neo4j-driver",
33
"version": "5.0.0-dev",
4-
"description": "Connect to Neo4j 3.5.0 and up from JavaScript",
4+
"description": "The official Neo4j driver for Javascript",
55
"author": "Neo4j",
66
"license": "Apache-2.0",
77
"repository": {

0 commit comments

Comments
 (0)