From ed407f4208026979639e56dc11fdd2e30fe2b8d4 Mon Sep 17 00:00:00 2001
From: zachmann <gabriel.zachmann@kit.edu>
Date: Fri, 8 May 2026 13:03:16 +0200
Subject: [PATCH] update README: adjust documentation link, add installation
 and usage instructions

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 43 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index e53c926..3d8dcc8 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,6 @@
 
 [![License](https://img.shields.io/github/license/oidc-mytoken/client.svg)](https://github.com/oidc-mytoken/client/blob/master/LICENSE)
 ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/oidc-mytoken/client)
-![GitHub Workflow Status](https://img.shields.io/github/workflow/status/oidc-mytoken/client/Go)
 [![Go Report](https://goreportcard.com/badge/github.com/oidc-mytoken/client)](https://goreportcard.com/report/github.com/oidc-mytoken/client)
 [![DeepSource](https://deepsource.io/gh/oidc-mytoken/client.svg/?label=active+issues&show_trend=true)](https://deepsource.io/gh/oidc-mytoken/client/?ref=repository-badge)
 [![Release date](https://img.shields.io/github/release-date/oidc-mytoken/client.svg)](https://github.com/oidc-mytoken/client/releases/latest)
@@ -24,7 +23,49 @@ any device. These `mytokens` can be restricted according to the particular use c
 A demo instance of the server and webinterface is available at
 [https://mytoken.data.kit.edu/](https://mytoken.data.kit.edu/).
 
-Documentation is available at [https://mytoken-docs.data.kit.edu/](https://mytoken-docs.data.kit.edu/).
+Documentation is available at [https://docs.mytok.eu/](https://docs.mytok.eu/).
 
 A go library for interacting with the mytoken server can be found at
 [https://github.com/oidc-mytoken/lib](https://github.com/oidc-mytoken/lib).
+
+# Quickstart
+
+## Installation
+
+Packaged versions are available from http://repo.data.kit.edu
+
+The latest version can also be installed via `go`:
+
+```bash
+go install github.com/oidc-mytoken/client/cmd/mytoken@latest
+```
+
+## Basic Usage
+
+### Obtain a mytoken
+
+Get a mytoken:
+
+```bash
+mytoken MT --url <mytoken_url> -i <oidc_issuer_url> -o <path_to_MT>
+```
+
+The mytoken will be stored in `<path_to_MT>`.
+
+### Get an Access Token
+
+Use your mytoken to obtain an OIDC access token:
+
+```bash
+mytoken AT --MT-file <path_to_MT>
+```
+
+## Using Mytokens
+
+Mytokens can be provided in several ways:
+
+- **File** (default): Stored in `~/.mytoken/default/mytoken`
+- **Environment variable**: `mytoken AT --MT-env MYTOKEN_VAR`
+- **From file**: `mytoken AT --MT-file /path/to/token`
+- **Interactive prompt**: `mytoken AT --MT-prompt`
+- **Direct**: `mytoken AT --MT <token>` (less secure)