From 1570e5d634748a5707e069cfb637eefd9dbb93a2 Mon Sep 17 00:00:00 2001 From: Thomas Faust Date: Fri, 8 Nov 2024 11:30:19 +0100 Subject: [PATCH] docs(README.md): revamp the goal section (#467) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Remove dangerous wording "client" because this library is not meant to be within the node runtime and serves as a SDK. Co-authored-by: Christoph Bühler --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b7283a20..068248cd 100644 --- a/README.md +++ b/README.md @@ -23,9 +23,9 @@ If you want to use `passport js` and OAuth 2.0 introspection, head over to ## Goals -This is the "client library" for the ZITADEL API. It contains the compiled +This is meant to be a Node.js SDK for the ZITADEL API. It contains the compiled proto files from the original ZITADEL repository and therefore helps to -access the API and manage ressources. Also, it contains helpers to +access the API and manage resources. Moreover, it contains helpers to authenticate a given service account against ZITADEL. To summarize: