From 6266f6d20f9296395db4a64d27e2989347f128aa Mon Sep 17 00:00:00 2001
From: "franz.germann1" <franz.germann@telekom.de>
Date: Wed, 18 Dec 2024 12:36:33 +0100
Subject: [PATCH] updates main readme

---
 README.md | 97 +++++++------------------------------------------------
 1 file changed, 12 insertions(+), 85 deletions(-)

diff --git a/README.md b/README.md
index bfbb932..14432a4 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# 🌟 EdgeDeveloperPlatform - EDP Release 'PoC' - Franz
+# 🌟 EdgeDeveloperPlatform - EDP Release 'PoC'
 
 Telekom MMS & T-Systems, December 2024
 
@@ -6,27 +6,22 @@ Telekom MMS & T-Systems, December 2024
 
 ---
 
-This file describes how you can read the EDP documentation and run and use the platform.
-
 ## 📋 Table of Contents
 
 - [🌟 EdgeDeveloperPlatform - EDP Release 'PoC'](#-edgedeveloperplatform---edp-release-poc)
   - [📋 Table of Contents](#-table-of-contents)
   - [📖 About the Product](#-about-the-product)
     - [🛠️ Application Stack](#️-application-stack)
-  - [✔️ Prerequisites](#️-prerequisites)
-  - [🚀 Installation](#-installation)
   - [📖 Access our Documentation](#-access-our-documentation)
-  - [📷 Screenshots](#-screenshots)
-  - [🤝 Contributing](#-contributing)
   - [📝 License](#-license)
 
 ---
 
 ## 📖 About the Product
 
-**eDF_PoC** is a tool to quickly instantiate and manage IDPs. The eDF builder can easily setup a Kubenetes cluster (local kind cluster or OSC instance) and deploy tools to manage the Kubernetes resources and the software lifecicle of an application.
-One usecase to demonstrate the capabilities of our tool is the Fibonacci Go Application.(<https://forgejo.edf-bootstrap.cx.fg1.ffm.osc.live/Franz.Germann/fibonacci_go>).
+**edpbuilder** is a tool to quickly instantiate and manage **I**nternal **D**eveloper **P**latform's (**IDP**s).
+The **E**dge **D**eveloper **P**latform Builder(**edp**builder) can easily setup a Kubenetes cluster (local kind cluster or OSC instance) and deploy tools to manage the Kubernetes resources and the software lifecicle of an application.
+One usecase to demonstrate the capabilities of our tool is the PetClinic Application. (LINK)
 
 ### 🛠️ Application Stack
 
@@ -39,87 +34,19 @@ One usecase to demonstrate the capabilities of our tool is the Fibonacci Go Appl
 - **Secret-Management:** OpenBao, external-secrets
 - **Infrastructur-Provisioning:** Crossplane
 
----
-
-## ✔️ Prerequisites
-
-- **Tools you'll need to execute the scripts:**
-  - go
-  - curl
-  - jq
-  - git
-  - openssl
-  - docker
-  - kind
-  - kubectlmikefarah/yq
-  - helm
-
----
-
-## 🚀 Installation
-
-1. Clone the repository:
-
-   ```bash
-   git clone https://forgejo.edf-bootstrap.cx.fg1.ffm.osc.live/DevFW/edf_poc.git
-   cd edf_poc
-
-2. List all kind clusters:
-
-    ```bash
-    kind get clusters
-    Output:
-    primary
-    shoot
-
-3. Delete all clusters:
-
-    ```bash
-    kind delete clusters primary shoot
- 
-4. start edfbuilder
-
-    ```bash
-    cd edfbuilder
-    git pull
-    ./start.sh
- 
-5. In a second terminal when the edfbuilder is ready:
-
-    ```bash
-    ./example.sh
-
-6. Get all the passwords:
-
-    ```bash
-    ./getpassword.sh
-
----
-
 ## 📖 Access our Documentation
 
-- 3 ways
-  - via backstage in the osc
-  - via file structure in forgejo
-  - via local backstage in local kind cluster (link to install guide in git repo(seperate file))
+Our documentation is designed to be easily accessible regardless of your environment. Here are three primary ways to view it:
 
----
+1. **Backstage in Our OSC**  
+   Our documentation can be easily accessed through a Backstage instance hosted on our Open Sovereign Cloud (OSC). Simply log in to our OSC Backstage platform to read through the documentation.
 
-## 📷 Screenshots
+2. **Local Backstage in a Kind Cluster**  
+    Using the edpbuilder, you can set up a local IDP that comes with a Backstage instance containing the documentation.
+   *How to set up a local IDP on a kind cluster is explained here: XXXXX*
 
-[IMAGES]
-
----
-
-## 🤝 Contributing
-
-Contributions are welcome! 🎉
-
-    Fork the project.
-    Create a feature branch (git checkout -b feature/YourFeature).
-    Commit your changes (git commit -m 'Add a new feature').
-    Push to the branch (git push origin feature/YourFeature).
-    Open a Pull Request.
+3. **Forgejo Repository**  
+    If you prefer direct access, the content of our documentation is centrally defined and maintained within the docs folder of this repository.
 
 ---