doc: added warning: do not treat as api yet (#55)

This commit is contained in:
Hendrik Eeckhaut
2024-09-20 07:20:16 +02:00
committed by GitHub
parent 313896a986
commit 756cdb4f1f

View File

@@ -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`.