Skip to content

Commit

Permalink
Update readme with 5.0 release version info. (#655)
Browse files Browse the repository at this point in the history
* update readme with 5.0 version info.
  • Loading branch information
thelonelyvulpes authored Oct 27, 2022
1 parent 1eb3742 commit 8b92f71
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Neo4j .NET Driver
This is the official Neo4j .NET driver for connecting to Neo4j 4.0.0+ databases via in-house binary protocol Bolt.
This is the official Neo4j driver for .NET.

Resources to get you started:
* [Nuget](https://www.nuget.org/profiles/Neo4j) for getting the latest driver.
Expand All @@ -12,6 +12,13 @@ This section is prepared for application developers who would like to use this d

For users who wish to migrate from 1.7 series to 4.0, checkout our [migration guide](#migrating-from-17-to-40).

## Versions
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(Excluding the Neo4j.Driver.Experimental namespace).

See also: https://neo4j.com/developer/kb/neo4j-supported-versions/

### Getting the Driver

The Neo4j driver is distributed under three packages:
Expand Down Expand Up @@ -281,4 +288,4 @@ The driver targets at .NET Standard 2.0. and .NET 5.0
As a result, it can be compiled and run on linux machines after installing for example .NET Core 2.0 library.
As for IDE, we recommend Rider for daily development.
The integration tests require [boltkit](https://github.com/neo4j-contrib/boltkit) to be installed and accessible via command line.
If any problem to start a Neo4j Server on your machine, you can start the test Bolt Server yourself at `localhost:7687` and then set environment variable `DOTNET_DRIVER_USING_LOCAL_SERVER=true`
If any problem to start a Neo4j Server on your machine, you can start the test Bolt Server yourself at `localhost:7687` and then set environment variable `DOTNET_DRIVER_USING_LOCAL_SERVER=true`

0 comments on commit 8b92f71

Please sign in to comment.