From 5473adf0b44639e285d054e290645222c7a0712d Mon Sep 17 00:00:00 2001
From: Max Peintner <max@caos.ch>
Date: Fri, 5 May 2023 16:32:57 +0200
Subject: [PATCH] update readme

---
 README.md                                     | 23 +++++++++++++++++++
 .../app/(login)/register/success/page.tsx     |  2 +-
 2 files changed, 24 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d82269dfd7c..6557abed216 100644
--- a/README.md
+++ b/README.md
@@ -28,6 +28,7 @@ This repo has some additional tools:
 
 ### Useful commands
 
+- `pnpm generate` - Build proto stubs for server and client package
 - `pnpm build` - Build all packages and the login app
 - `pnpm dev` - Develop all packages and the login app
 - `pnpm lint` - Lint all packages
@@ -63,3 +64,25 @@ See [Working with the npm registry](https://docs.github.com/en/packages/working-
 - Buf setup to get grpc stub in the core package
 - Decide whether a seperate client package is required to expose public client convenience methods only or generate a grpc-web output there
 - Fix #/\* path in login application
+
+### Run Login UI
+
+To run the application make sure to install the dependencies with
+
+```sh
+pnpm install
+```
+
+then generate the GRPC stubs with
+
+```sh
+pnpm generate
+```
+
+and then run it with
+
+```sh
+pnpm dev
+```
+
+The login application with run on `localhost:3000`.
diff --git a/apps/login/app/(login)/register/success/page.tsx b/apps/login/app/(login)/register/success/page.tsx
index cf7a3d43b9a..bf133037e92 100644
--- a/apps/login/app/(login)/register/success/page.tsx
+++ b/apps/login/app/(login)/register/success/page.tsx
@@ -14,7 +14,7 @@ export default async function Page({ searchParams }: Props) {
 
       {`userId: ${searchParams["userid"]}`}
       <Link href="/register">
-        <Button variant={ButtonVariants.Primary}>go back</Button>
+        <Button variant={ButtonVariants.Primary}>back</Button>
       </Link>
     </div>
   );