fix: improve readme

Author: n3rdc4ptn

README.md

@@ -4,25 +4,17 @@
 
 ## About this project
 
-UI backend for @openmcp-project
+This is the backend for our [MCP UI](https://github.com/openmcp-project/ui-frontend).
+Its a simple proxy server which sits between the UI frontend and the Kubernetes API server.
 
-## Requirements and Setup
-
-Setup: Requires the CRATE_KUBECONFIG environment variable.
-Start: Instructions to run the server using go run cmd/server/main.go.
-Call UI-backend: Details on how to make requests to the ui-backend with necessary headers for authorization and target API server configuration.
-Parsing JSON: Support for jsonpath and jq to parse JSON before sending it to the client.
-
-### Use Case
-
-#### Problem
+### Motivation
 
 We want to call the kubernetes api server directly from the browser, but we have several problems preventing us from calling the api from the browser:
 
 - TLS certificate is not signed from a well-known CA
 - CORS is not configured most of the time
 
-#### Solution
+### Solution
 
 The `ui-backend` server acts like a proxy when talking to the Crate-Cluster or MCPs from the browser.
 The browser sends the request to the `ui-backend`, with authorization data and optionally the project, workspace and controlplane name of the MCP in header data.
@@ -32,34 +24,39 @@ The browser sends the request to the `ui-backend`, with authorization data and o
 
 There are only some modifications done when piping the request to the api server, preventing some headers from going through.
 
-### Usage
+## Requirements and Setup
+
+You need to have a running mcp landscape. Then reference the KUBECONFIG for the backend using the `KUBECONFIG` environment variable.
 
-#### Setup
+The backend can be started using:
 
-The service needs only one mandatory environment variable, `CRATE_KUBECONFIG`, with the kubeconfig-yaml as a string. The `.users` field does not has to be set, as this part will get overwritten with the data from the requests.
+```bash
+go run cmd/server/main.go
+```
 
-#### Start
+## Usage
 
-Run `go run cmd/server/main.go`
+You can reach the backend on port `3000` and the path as you would directly to the api server.
 
-#### Call UI-backend
+```txt
+For example: http://localhost:3000/api/v1/namespaces
+```
 
-Call `ui-backend` with the http-method and path as you would directly to the api server.
 Put the authorization data in the following headers:
 
 - `X-Client-Certificate-Data`
 - `X-Client-Key-Data`
 
 or (for OIDC):
 
-- `Authorization`
+- `Authorization: <token>`
 
 Also configure the api-server you want to call:
 
 - Crate: Add the header `X-Use-Crate-Cluster: true`
 - MCP: Add the headers `X-Project-Name`, `X-Workspace-Name` and `X-Control-Plane-Name`
 
-#### Parsing JSON
+## Parsing JSON
 
 `ui-backend` support jsonpath (kubectl version) and jq (gojq) to parse json before sending it to the client, reducing the data transfered to the client.
 
@@ -70,8 +67,7 @@ Usage:
 
 ### Deployment
 
-- Docker-Image: deploy-releases-hyperspace-docker.common.repositories.cloud.sap/cloud-orchestration/cola/ui-backend
-- Helm-Chart: oci://europe-docker.pkg.dev/sap-gcp-cp-k8s-stable-hub/cola/charts/ui-backend (is manually pushed)
+- Docker-Image: ghcr.io/openmcp-project/ui-backend
 
 ## Support, Feedback, Contributing