From 199ec434e814ef6612ae8fa7e0800e0b24ce34ff Mon Sep 17 00:00:00 2001 From: Antonio Barcelos Date: Wed, 19 May 2021 14:09:15 +0200 Subject: [PATCH] Add disclaimer about the usage of bolt-connection and core modules --- bolt-connection/README.md | 4 +++- core/README.md | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/bolt-connection/README.md b/bolt-connection/README.md index 7715ab4cc..4c99d694c 100644 --- a/bolt-connection/README.md +++ b/bolt-connection/README.md @@ -1,6 +1,8 @@ # Bolt connection module of the Neo4j Driver for JavaScript -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. +> :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`.** + +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. ## Building diff --git a/core/README.md b/core/README.md index bf746bff2..299bed9c0 100644 --- a/core/README.md +++ b/core/README.md @@ -1,6 +1,8 @@ # Core module of the Neo4j Driver for JavaScript -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`. +> :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.** + +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`. ## Building