Skip to content

Commit

Permalink
docs(README.md): revamp the goal section (#467)
Browse files Browse the repository at this point in the history
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 <buehler@users.noreply.github.com>
  • Loading branch information
tafaust and buehler authored Nov 8, 2024
1 parent c6a528e commit 1570e5d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 1570e5d

Please sign in to comment.