From 756cdb4f1f1420c70a3d84c5a159d21a425669ee Mon Sep 17 00:00:00 2001
From: Hendrik Eeckhaut <hendrik@eeckhaut.org>
Date: Fri, 20 Sep 2024 07:20:16 +0200
Subject: [PATCH] doc: added warning: do not treat as api yet (#55)

---
 readme.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/readme.md b/readme.md
index 15c69b4..97b73f2 100644
--- a/readme.md
+++ b/readme.md
@@ -10,6 +10,10 @@ NPM Modules for proving and verifying using TLSNotary in the browser.
 
 The prover requires a [notary-server](https://github.com/tlsnotary/notary-server) and a websocket proxy
 
+> [!IMPORTANT]
+> The primary purpose of `tlsn-js` is to support the development of the [TLSNotary browser extension](https://github.com/tlsnotary/tlsn-extension/).  
+> **Please do not treat this as a public API (yet).**
+
 > [!IMPORTANT]
 > `tlsn-js` is developed for the usage of TLSNotary **in the Browser**. This module does not work in `nodejs`.