mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-23 22:07:41 +00:00
add readme
This commit is contained in:
42
packages/zitadel-client/README.md
Normal file
42
packages/zitadel-client/README.md
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
# ZITADEL Client
|
||||||
|
|
||||||
|
This package exports services and utilities to interact with ZITADEL
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
To install the package, use npm or yarn:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm install @zitadel/client
|
||||||
|
```
|
||||||
|
|
||||||
|
or
|
||||||
|
|
||||||
|
```sh
|
||||||
|
yarn add @zitadel/client
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### Importing Services
|
||||||
|
|
||||||
|
You can import and use the services provided by this package to interact with ZITADEL.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { createUserServiceClient } from "@zitadel/client";
|
||||||
|
|
||||||
|
const userService = createUserServiceClient({
|
||||||
|
// Configuration options
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Utilities
|
||||||
|
|
||||||
|
This package also provides various utilities to work with ZITADEL
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { timestampMs } from "@zitadel/client";
|
||||||
|
|
||||||
|
// Example usage
|
||||||
|
console.log(`${timestampMs(session.creationDate)}`);
|
||||||
|
```
|
Reference in New Issue
Block a user