From 89ae2e341bb04d00b572f8b3e5625fb901eb53f2 Mon Sep 17 00:00:00 2001 From: ndr_brt Date: Wed, 9 Sep 2026 13:49:28 +0200 Subject: [PATCH] docs: adds disclaimer about the library --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 364b43a..0e17c9a 100644 --- a/README.md +++ b/README.md @@ -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.