Skip to content

docs: adds disclaimer about the library #128

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
ndr-brt merged 1 commit into from
Sep 9, 2026
Merged

docs: adds disclaimer about the library #128

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
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,15 @@ These dataplanes can interact with
via the `Dataplane Signaling API`.

For information on how to use the SDK, check out the [getting started guide](./docs/getting-started.md).

## Important Notice

This is an **SDK** — it provides building blocks and abstractions to help you implement a data plane, but it is **not a final product** and is **not production-ready**.

Key responsibilities left to the implementor:

- **Authentication and authorization**: the SDK does not enforce any auth mechanism. You are expected to implement token validation, access control, and any other security checks appropriate for your deployment.
- **Production hardening**: error handling, observability, and operational concerns are not covered out of the box.
- **Deployment configuration**: TLS, network policies, and infrastructure setup are outside the scope of this SDK.

Use this SDK as a foundation and build the necessary production-grade concerns on top of it.