Skip to content

6.0 Readme updates #1337

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 1 commit into from
Sep 25, 2025
Merged

6.0 Readme updates #1337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This is the official Neo4j driver for JavaScript.

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.
Starting with 6.0, the Neo4j Drivers is no longer on a monthly release cadence. Minor version releases will happen when there are sufficient new features or improvements to warrant them. This is to reduce the required work of users updating their driver.

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 All @@ -14,9 +14,9 @@ Resources to get you started:
- [Neo4j Driver Manual](https://neo4j.com/docs/javascript-manual/current/)
- [Neo4j Cypher Cheatsheet](http://neo4j.com/docs/cypher-cheat-sheet/)

## What's New in 5.x
## What's New in 6.x

- [Changelog](https://github.com/neo4j/neo4j-javascript-driver/wiki/5.0-changelog)
- [Changelog](https://github.com/neo4j/neo4j-javascript-driver/wiki/6.x-changelog)

## Including the Driver

Expand Down
4 changes: 2 additions & 2 deletions TESTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Watch is not supported in the package `neo4j-driver`.

## Testing using Testkit

Tests **require** latest [Testkit 5](https://github.com/neo4j-drivers/testkit/tree/5.0), Python3 and Docker.
Tests **require** latest [Testkit 6](https://github.com/neo4j-drivers/testkit/tree/6.x), Python3 and Docker.

Testkit is needed to be cloned and configured to run against the Javascript Lite Driver. Use the following steps to configure Testkit.

Expand Down Expand Up @@ -62,7 +62,7 @@ To run test against against some Neo4j version:
python3 main.py
```

More details about how to use Testkit could be found on [its repository](https://github.com/neo4j-drivers/testkit/tree/5.0)
More details about how to use Testkit could be found on [its repository](https://github.com/neo4j-drivers/testkit/tree/6.x)

## Testing (Legacy)

Expand Down
7 changes: 3 additions & 4 deletions packages/neo4j-driver-deno/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This version of driver is based in the `neo4j-driver-lite`.
So, this version 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.
Starting with 6.0, the Neo4j Drivers is no longer on a monthly release cadence. Minor version releases will happen when there are sufficient new features or improvements to warrant them. This is to reduce the required work of users updating their driver.

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 All @@ -19,11 +19,10 @@ Resources to get you started:
- [API Documentation](https://neo4j.com/docs/api/javascript-driver/current/)
- [Neo4j Driver Manual](https://neo4j.com/docs/javascript-manual/current/)
- [Neo4j Cypher Cheatsheet](http://neo4j.com/docs/cypher-cheat-sheet/)
- [TLS](#tls)

## What's New in 5.x
## What's New in 6.x

- [Changelog](https://github.com/neo4j/neo4j-javascript-driver/wiki/5.0-changelog)
- [Changelog](https://github.com/neo4j/neo4j-javascript-driver/wiki/6.x-changelog)

## Usage

Expand Down
7 changes: 3 additions & 4 deletions packages/neo4j-driver-deno/lib/README.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions packages/neo4j-driver-lite/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ 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.
Starting with 6.0, the Neo4j Drivers is no longer on a monthly release cadence. Minor version releases will happen when there are sufficient new features or improvements to warrant them. This is to reduce the required work of users updating their driver.

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 All @@ -17,9 +17,9 @@ Resources to get you started:
- [Neo4j Driver Manual](https://neo4j.com/docs/javascript-manual/current/)
- [Neo4j Cypher Cheatsheet](http://neo4j.com/docs/cypher-cheat-sheet/)

## What's New in 5.x
## What's New in 6.x

- [Changelog](https://github.com/neo4j/neo4j-javascript-driver/wiki/5.0-changelog)
- [Changelog](https://github.com/neo4j/neo4j-javascript-driver/wiki/6.x-changelog)

## Including the Driver

Expand Down
6 changes: 3 additions & 3 deletions packages/neo4j-driver/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This is the official Neo4j driver for JavaScript.

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.
Starting with 6.0, the Neo4j Drivers is no longer on a monthly release cadence. Minor version releases will happen when there are sufficient new features or improvements to warrant them. This is to reduce the required work of users updating their driver.

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 All @@ -14,9 +14,9 @@ Resources to get you started:
- [Neo4j Driver Manual](https://neo4j.com/docs/javascript-manual/current/)
- [Neo4j Cypher Cheatsheet](http://neo4j.com/docs/cypher-cheat-sheet/)

## What's New in 5.x
## What's New in 6.x

- [Changelog](https://github.com/neo4j/neo4j-javascript-driver/wiki/5.0-changelog)
- [Changelog](https://github.com/neo4j/neo4j-javascript-driver/wiki/6.x-changelog)

## Including the Driver

Expand Down