Skip to content

Add disclaimer about the usage of bolt-connection and core modules #738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 19, 2021
Merged

Add disclaimer about the usage of bolt-connection and core modules #738

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion bolt-connection/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 3 additions & 1 deletion core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down