From 739c08a19b6c8ce7b0b8592ea0ba762b7405f957 Mon Sep 17 00:00:00 2001
From: Max Peintner <peintnerm@gmail.com>
Date: Fri, 3 Jan 2025 14:21:27 +0100
Subject: [PATCH] fix: missing readme

---
 packages/zitadel-client/README.md | 19 +++++++++++++----
 packages/zitadel-proto/README.md  | 35 +++++++++++++++++++++++++++++++
 2 files changed, 50 insertions(+), 4 deletions(-)
 create mode 100644 packages/zitadel-proto/README.md

diff --git a/packages/zitadel-client/README.md b/packages/zitadel-client/README.md
index f055ebaf8e..0a14fe32f5 100644
--- a/packages/zitadel-client/README.md
+++ b/packages/zitadel-client/README.md
@@ -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.
diff --git a/packages/zitadel-proto/README.md b/packages/zitadel-proto/README.md
new file mode 100644
index 0000000000..bf8a064c12
--- /dev/null
+++ b/packages/zitadel-proto/README.md
@@ -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.