mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-15 10:07:38 +00:00
fix: missing readme
This commit is contained in:
@@ -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.
|
||||
|
35
packages/zitadel-proto/README.md
Normal file
35
packages/zitadel-proto/README.md
Normal 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.
|
Reference in New Issue
Block a user