fix: missing readme

This commit is contained in:
Max Peintner
2025-01-03 14:21:27 +01:00
parent 6446d9483f
commit 739c08a19b
2 changed files with 50 additions and 4 deletions

View File

@@ -23,11 +23,14 @@ yarn add @zitadel/client
You can import and use the services provided by this package to interact with ZITADEL.
```ts
import { createUserServiceClient } from "@zitadel/client";
import { createSettingsServiceClient, makeReqCtx } from "@zitadel/client/v2";
const userService = createUserServiceClient({
// Configuration options
});
// 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
@@ -40,3 +43,11 @@ 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.

View File

@@ -0,0 +1,35 @@
# ZITADEL Proto
This package provides the Protocol Buffers (proto) definitions used by ZITADEL projects. It includes the proto files and generated code for interacting with ZITADEL's gRPC APIs.
## Installation
To install the package, use npm or yarn:
```sh
npm install @zitadel/proto
```
or
```sh
yarn add @zitadel/proto
```
## Usage
To use the proto definitions in your project, import the generated code:
```ts
import { Organization } from "@zitadel/proto/zitadel/org/v2/org_pb";
const org: Organization | null = await getDefaultOrg();
```
## 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.