Skip to content

Commit 876d8e1

Browse files
authored
Add disclaimer about the usage of bolt-connection and core modules (#738)
1 parent 9ad84bd commit 876d8e1

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

bolt-connection/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Bolt connection module of the Neo4j Driver for JavaScript
22

3-
This is an internal package shared by the `neo4j-driver` and the `neo4j-driver-lite` drivers. This package is responsible for implementing the [Bolt Protocol](https://7687.org/) using the `Connection` and `ConnectionProvider` interfaces defined by `neo4j-driver-core` package.
3+
> :warning: **This package is not intended to be used by end users, it contains the basic tools used by the `neo4j-driver` to connect to `Neo4j`.**
4+
5+
This is an internal package shared by the [neo4j-driver](https://www.npmjs.com/package/neo4j-driver) and the [neo4j-driver-lite](https://www.npmjs.com/package/neo4j-driver-lite) drivers. This package is responsible for implementing the [Bolt Protocol](https://7687.org/) using the `Connection` and `ConnectionProvider` interfaces defined by `neo4j-driver-core` package.
46

57
## Building
68

core/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Core module of the Neo4j Driver for JavaScript
22

3-
This is a internal package shared by the `neo4j-driver` and the `neo4j-driver-lite` drivers. This package is responsible for high level pieces of the driver such as `Session`, `Result`, `Record`, some data types and the interface for `Connection` and `ConnectionProvider`.
3+
> :warning: **This package is not intended to be used by end users, it contains the abstractions used by the `neo4j-driver` to handle `Neo4j` connections.**
4+
5+
This is a internal package shared by the [neo4j-driver](https://www.npmjs.com/package/neo4j-driver) and the [neo4j-driver-lite](https://www.npmjs.com/package/neo4j-driver-lite) drivers. This package is responsible for high level pieces of the driver such as `Session`, `Result`, `Record`, some data types and the interface for `Connection` and `ConnectionProvider`.
46

57
## Building
68

0 commit comments

Comments
 (0)