From a688eb105bb0a187a83019e1ce3d07280f02b86d Mon Sep 17 00:00:00 2001
From: Jan Dittberner <jandd@cacert.org>
Date: Sat, 3 Dec 2022 12:58:28 +0100
Subject: [PATCH] Add documentation how to run the signer client

---
 README.md | 31 ++++++++++++++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 10466b2..91942f0 100644
--- a/README.md
+++ b/README.md
@@ -18,10 +18,39 @@ Read the documentation of these tools, to find out how to use them.
 
 ## Building the binary
 
-There is a `Makefile` to build the signerclient binary. Run
+There is a `Makefile` to build the `signerclient` binary. Run
 
 ```shell
 make
 ```
 
 to run linting, tests and binary builds.
+
+## Running the signer client
+
+The signer client requires a YAML configuration file to know some information about its runtime environment. The
+default configuration file name is `config.yaml` in the working directory.
+
+### Generating a configuration file
+
+Example configuration data is generated when the client is run with the `-generate-config` command line argument:
+
+```shell
+./signerclient -generate-config
+```
+
+### Start the client
+
+With `config.yaml` in the current directory you can start the client:
+
+```shell
+./signerclient
+```
+
+### Supported command line arguments
+
+To get a list of supported command line arguments run:
+
+```shell
+./signerclient -help
+```
\ No newline at end of file