Skip to content

Commit f18d217

Browse files
authored
Update README and docs
* Consistent bolt protocol support claims * Include calver versions in list of supported server versions * Update bolt docs links
1 parent a2316b9 commit f18d217

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,20 @@ Neo4j Driver for Rust
44
Disclaimer:
55
* While I'm currently affiliated with Neo4j, this is my private hobby project.
66
It's not an officially supported piece of software by Neo4j.
7-
* This is a work in progress, and it's mostly developed in my spare time.
7+
* This software is mostly developed in my spare time.
88
* This project is primarily meant for private studies.
99
Yet, I decided to publish it as it might be useful for others as well.
1010

1111

1212
## Driver
13-
This is a driver for Neo4j using the [Bolt protocol](https://7687.org) written in and for Rust.
13+
This is a driver for Neo4j using the [Bolt protocol](https://neo4j.com/docs/bolt/) written in and for Rust.
1414
It’s designed to mirror many concepts of the official drivers while leveraging Rust’s expressive type system and lifetime management to provide a safer API that prevents many common pitfalls already at compile time.
1515

1616
### Compatibility
17-
This driver supports bolt protocol version 4.4, and 5.0 - 5.8.
18-
This corresponds to Neo4j versions 4.4, and the whole 5.x series.
17+
This driver supports bolt protocol version 4.4, 5.0 - 5.8, and 6.0.
18+
This corresponds to Neo4j versions 4.4, the whole 5.x series, and 2025.01 - 2026.02.
1919
Newer versions of Neo4j are supported as long as they keep support for at least one of the protocol versions mentioned above.
20-
For details of bolt protocol compatibility, see the [official Neo4j documentation](https://7687.org/bolt-compatibility/).
20+
For details of bolt protocol compatibility, see the [official Neo4j documentation](https://neo4j.com/docs/bolt/current/bolt-compatibility/).
2121

2222
### Basic Example
2323

@@ -167,7 +167,7 @@ A bump in MSRV is considered a minor breaking change.
167167
* [x] 5.8 (home db resolution cache)
168168
* [x] 6.0
169169
* [x] (vector types)
170-
* [ ] (unsupported type)
170+
* [x] (unsupported type)
171171
* [x] Types
172172
* [x] `Null`
173173
* [x] `Integer`
@@ -182,14 +182,17 @@ A bump in MSRV is considered a minor breaking change.
182182
* [x] `Path`
183183
* [x] `Spatial` (point)
184184
* [x] `Temporal` (date, time, datetime, duration)
185-
* [ ] Proper Unit Tests
185+
* [x] `Vector`
186+
* [x] `Unsupported`
186187
* [x] CI
187188
* [x] rustfmt
188189
* [x] clippy
189190
* [x] Unit Tests
190191
* [x] Public API SemVer Compatibility Tests ([cargo-public-api](https://github.com/enselic/cargo-public-api))
192+
* [ ] High test coverage
191193
* [x] Exposed Dependency Types Check ([cargo-check-external-types](https://github.com/awslabs/cargo-check-external-types))
192-
* [x] TestKit
194+
* [x] [TestKit](https://github.com/neo4j-drivers/testkit/) integration (acceptance testing framework for drivers developed by neo4j)
195+
* [ ] [Trusted publishing](https://crates.io/docs/trusted-publishing)
193196

194197

195198
## Note on async

neo4j/src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@
3535
//! ## Compatibility
3636
// [bolt-version-bump] search tag when changing bolt version support
3737
//! This driver supports bolt protocol version 4.4, 5.0 - 5.8, and 6.0.
38-
//! This corresponds to Neo4j versions 4.4, and the whole 5.x series.
38+
//! This corresponds to Neo4j versions 4.4, the whole 5.x series, and 2025.01 - 2026.02.
3939
//! Newer versions of Neo4j are supported as long as they keep support for at least one of the
4040
//! protocol versions mentioned above.
4141
//! For details of bolt protocol compatibility, see the
42-
//! [official Neo4j documentation](https://7687.org/bolt-compatibility/).
42+
//! [official Neo4j documentation](https://neo4j.com/docs/bolt/current/bolt-compatibility/).
4343
//!
4444
//! ## Basic Example
4545
//! ```

0 commit comments

Comments
 (0)