From 74e5b0393a8c727f178e29cce72447e497f408a0 Mon Sep 17 00:00:00 2001
From: Max Peintner <peintnerm@gmail.com>
Date: Fri, 3 Jan 2025 14:05:47 +0100
Subject: [PATCH] add readme

---
 packages/zitadel-client/README.md | 42 +++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 packages/zitadel-client/README.md

diff --git a/packages/zitadel-client/README.md b/packages/zitadel-client/README.md
new file mode 100644
index 0000000000..f055ebaf8e
--- /dev/null
+++ b/packages/zitadel-client/README.md
@@ -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)}`);
+```