Skip to content

Improve docs around packages and versions #1054

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 25, 2023
Merged

Improve docs around packages and versions #1054

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
454b14a
Improve docs around packages and versions
bigmontz Jan 25, 2023
18505d6
Update packages/neo4j-driver-lite/README.md
bigmontz Jan 25, 2023
aa9c543
Apply suggestions from code review
bigmontz Jan 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion packages/neo4j-driver-lite/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# Neo4j Driver for JavaScript
# Neo4j Lite Driver for JavaScript

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

This version of the driver has the same capabilities as the Neo4j Driver except for the support of reactive sessions.
This means it doesn't have the `RxJS` dependency and the `Driver#rxSession` api.

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.

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.
Expand Down
2 changes: 1 addition & 1 deletion packages/neo4j-driver-lite/esdoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
"enable": false
},
"brand": {
"title": "Neo4j Bolt Driver 4.4 for JavaScript",
"title": "Neo4j Bolt Lite Driver 5.x for JavaScript",
"repository": "https://github.com/neo4j/neo4j-javascript-driver"
}
}
Expand Down
2 changes: 1 addition & 1 deletion packages/neo4j-driver-lite/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "neo4j-driver-lite",
"version": "5.0.0-dev",
"description": "Connect to Neo4j 3.5.0 and up from JavaScript",
"description": "The official Neo4j lite driver for Javascript",
"main": "lib/index.js",
"types": "types/index.d.ts",
"scripts": {
Expand Down
2 changes: 1 addition & 1 deletion packages/neo4j-driver/esdoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
"enable": true
},
"brand": {
"title": "Neo4j Bolt Driver 4.4 for JavaScript",
"title": "Neo4j Bolt Driver 5.x for JavaScript",
"repository": "https://github.com/neo4j/neo4j-javascript-driver"
}
}
Expand Down
2 changes: 1 addition & 1 deletion packages/neo4j-driver/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "neo4j-driver",
"version": "5.0.0-dev",
"description": "Connect to Neo4j 3.5.0 and up from JavaScript",
"description": "The official Neo4j driver for Javascript",
"author": "Neo4j",
"license": "Apache-2.0",
"repository": {
Expand Down