mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-12 11:47:34 +00:00
use turbo convention
This commit is contained in:
53
packages/zitadel-client/README.md
Normal file
53
packages/zitadel-client/README.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# 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 { createSettingsServiceClient, makeReqCtx } from "@zitadel/client/v2";
|
||||
|
||||
// Example usage
|
||||
const transport = createServerTransport(process.env.ZITADEL_SERVICE_USER_TOKEN!, { baseUrl: process.env.ZITADEL_API_URL! });
|
||||
|
||||
const settingsService = createSettingsServiceClient(transport);
|
||||
|
||||
settingsService.getBrandingSettings({ ctx: makeReqCtx("orgId") }, {});
|
||||
```
|
||||
|
||||
### Utilities
|
||||
|
||||
This package also provides various utilities to work with ZITADEL
|
||||
|
||||
```ts
|
||||
import { timestampMs } from "@zitadel/client";
|
||||
|
||||
// Example usage
|
||||
console.log(`${timestampMs(session.creationDate)}`);
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
For detailed documentation and API references, please visit the [ZITADEL documentation](https://zitadel.com/docs).
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! Please read the contributing guidelines before getting started.
|
Reference in New Issue
Block a user