feat(dev): update README.md and introduce INSTALL.md for usage

INSTALL.md

@@ -0,0 +1,40 @@
+# Managed Identity Wallets
+
+If you just want to try out MIW (without any developer setup), then you can find a quick start guide here:
+
+(It will only work on macOS or GNU/Linux - For Windows,
+you need to use the [WSL](https://learn.microsoft.com/de-de/windows/wsl/install))
+
+- You need to install these tools:
+    - [Docker](https://docs.docker.com/desktop/) (or from your package manager)
+      -> Configure it to run without root permission
+    - Docker [compose plugin](https://docs.docker.com/compose/)
+    - [Taskfile](https://taskfile.dev)
+    - [jq](https://jqlang.github.io/jq/)
+- Clone this repo
+- (Optional) Checkout main (stable) or develop (latest), if not already checked out
+- Copy `dev-assets/env-files/env.docker.dist` to `dev-assets/env-files/env.docker`
+- Set these variables in `env.docker`
+    - POSTGRES_PASSWORD
+    - POSTGRES_PASSWORD_MIW
+    - KEYCLOAK_ADMIN_PASSWORD
+    - ENCRYPTION_KEY (32 random alphanumeric characters)
+    - GITHUB_USERNAME
+    - GITHUB_TOKEN
+- Follow the "docker" path of the "Development setup" to get it up and running:
+    1. Run `task docker:start-app` and wait until it shows "Started ManagedIdentityWalletsApplication in ... seconds"
+    2. Run `task app:get-token` and copy the token (including "BEARER" prefix) (Mac users have the token already in their clipboard :) )
+    3. Open API doc on http://localhost:8000
+    4. Click on Authorize on Swagger UI and on the dialog paste the token (incl. "Bearer") into the "value" input
+    5. Click on "Authorize" and "close"
+    6. MIW is up, running, and you are authorized to fire requests in the Swagger UI
+
+> [!IMPORTANT]  
+> To compile MIW,
+> you need a PAT with the permission `read:packages` to 
+> access `https://maven.pkg.github.com/catenax-ng/product-lab-ssi`.
+> 
+> That is, why you need to set `GITHUB_USERNAME` and `GITHUB_TOKEN`. Otherwise, you are not able to get the SSI-lib.
+
+> [!IMPORTANT]  
+> You need to use Java 17!

README.md

@@ -4,26 +4,7 @@ The Managed Identity Wallets (MIW) service implements the Self-Sovereign-Identit
 
 # Usage
 
-If you just want to try out MIW (without any developer setup), then you can find a quick start guide here:
-
-(It will only work on macOS or GNU/Linux - For Windows,
-you need to use the [WSL](https://learn.microsoft.com/de-de/windows/wsl/install))
-
-- You need to install these tools:
-   - [Docker](https://docs.docker.com/desktop/) (or from your package manager) 
-      -> Configure it to run without root permission
-   - Docker [compose plugin](https://docs.docker.com/compose/) 
-   - [Taskfile](https://taskfile.dev)
-   - [jq](https://jqlang.github.io/jq/)
-- Clone this repo
-- (Optional) Checkout main, if not already checked out
-- Follow the "docker" path of the "Development setup":
-   1. Run `task docker:start-app` and wait until it shows "Started ManagedIdentityWalletsApplication in ... seconds"
-   2. Run `task app:get-token` and copy the token (including "BEARER" prefix) (Mac users have the token already in their clipboard :) )
-   3. Open API doc on http://localhost:8000 (or what port you configured in the _env.local_ file)
-   4. Click on Authorize on swagger UI and on the dialog paste the token into the "value" input
-   5. Click on "Authorize" and "close"
-   6. MIW is up and running
+See [INSTALL.md](INSTALL.md) 
 
 # Developer Documentation