Skip to content

Commit cc76347

Browse files
committed
Update readme
1 parent 3bf4add commit cc76347

File tree

1 file changed

+20
-24
lines changed

1 file changed

+20
-24
lines changed

README.md

Lines changed: 20 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,26 @@
11
# Neo4j Java Driver
22

3-
This repository holds the official Java driver for Neo4j.
4-
The API is designed to work against both single instance and clustered databases.
3+
This repository holds the official Java Driver for Neo4j.
54

5+
It works with both single instance and clustered databases.
66

7-
## For Driver Users
7+
Network communication is handled using [Bolt Protocol](https://7687.org/).
88

9-
This section provides general information for developers who are building Neo4j-backed applications.
10-
Note that this driver is designed to be used only by Neo4j 3.0 and above and provides no HTTP capabilities.
9+
## Supported Driver Series
1110

11+
| Driver Series | Supported Java Runtime versions | Status | Changelog |
12+
| --- | --- | --- | --- |
13+
| 4.3 | 8, 11 | Primary development branch. | [link](https://github.com/neo4j/neo4j-java-driver/wiki/4.3-changelog) |
14+
| 4.2 | 8, 11 | Maintenance. | [link](https://github.com/neo4j/neo4j-java-driver/wiki/4.2-changelog) |
15+
| 4.1 | 8, 11 | Maintenance. | [link](https://github.com/neo4j/neo4j-java-driver/wiki/4.1-changelog) |
1216

13-
### Java Runtime
17+
## Server Compatibility
1418

15-
Recent drivers require the Java 8 or higher version of the runtime.
16-
The table below shows runtime compatibility for the currently-supported driver versions.
19+
The compatibility with Neo4j Server versions is documented in the [Neo4j Knowledge Base](https://neo4j.com/developer/kb/neo4j-supported-versions/).
1720

18-
| Driver Series | Java 8 | Java 11 |
19-
|---------------|:------:|:-------:|
20-
| 1.6 | X | X |
21-
| 1.7 | X | X |
22-
| 4.0 | X | X |
23-
24-
The automatic module name of the driver for the Java Module System is `org.neo4j.driver`.
21+
## Usage
2522

23+
This section provides general information for engineers who are building Neo4j-backed applications.
2624

2725
### The `pom.xml` file
2826

@@ -42,6 +40,9 @@ All available versions of this driver can be found at
4240
[Maven Central](https://mvnrepository.com/artifact/org.neo4j.driver/neo4j-java-driver) or
4341
[Releases](https://github.com/neo4j/neo4j-java-driver/releases).
4442

43+
### Java Module System
44+
45+
The automatic module name of the driver for the Java Module System is `org.neo4j.driver`.
4546

4647
### Example
4748

@@ -61,41 +62,36 @@ Network connections are acquired on demand from the pool when running Cypher que
6162
As a result of this design, it is expensive to create and close a ``Driver`` object.
6263
``Session`` objects, on the other hand, are very cheap to use.
6364

64-
6565
### Thread Safety
6666

6767
``Driver`` objects are thread-safe, but ``Session`` and ``Transaction`` objects should only be used by a single thread.
6868

69-
7069
### Further reading
7170
Check out our [Wiki](https://github.com/neo4j/neo4j-java-driver/wiki) for detailed and most up-to-date developer manuals, driver API documentations, changelogs, etc.
7271

73-
7472
### Bug Report
7573
If you encounter any bugs while using this driver, please follow the instructions in our [Contribution Guide](https://github.com/neo4j/neo4j-java-driver/blob/1.6/CONTRIBUTING.md#need-to-raise-an-issue)
7674
when raising an issue at [Issues](https://github.com/neo4j/neo4j-java-driver/issues).
7775

7876
When reporting, please mention the versions of the driver and server, as well as the server topology (single instance, causal cluster, etc).
7977
Also include any error stacktraces and a code snippet to reproduce the error if possible, as well as anything else that you think might be helpful.
8078

81-
82-
## For Driver Developers
79+
## For Driver Engineers
8380

8481
This section targets users who would like to compile the driver source code on their own machine for the purpose of, for example, contributing a PR.
8582
Before contributing to this project, please take a few minutes to read our [Contribution Guide](https://github.com/neo4j/neo4j-java-driver/blob/1.6/CONTRIBUTING.md#want-to-contribute).
8683

87-
8884
### Java Version
8985

90-
For the 1.5 series driver and above, source code _must_ compile on Java 8.
91-
For previous versions, the compilation requires Java 7.
86+
For the 1.5+ Driver Series, the source code _must_ compile on Java 8.
9287

88+
For the previous versions, the compilation requires Java 7.
9389

9490
### Building
9591

9692
The source code here reflects the current development status of a new driver version.
97-
To use the driver in a project, please use the released driver via Maven Central or check out the code with git tags of corresponding versions instead.
9893

94+
To use the driver in a project, please use the released driver via Maven Central or check out the code with git tags of corresponding versions instead.
9995

10096
#### Running Tests and Creating a Package
10197

0 commit comments

Comments
 (0)