Add documentation for configuration

Signed-off-by: Knut Ahlers <knut@ahlers.me>

Makefile

@@ -0,0 +1,4 @@
+documentation:
+	echo "| Key | Type | Description |" >config.md
+	echo "| --- | ---- | ----------- |" >>config.md
+	awk -F ' - ' '/#configStore/{ gsub(/.*configStore /, "", $$1); printf "| %s | %s | %s |\n", $$1, $$2, $$3 }' *.go | sort >>config.md

README.md

@@ -32,6 +32,16 @@ To embed them into Markdown pages like this `README.md`:
 
 - There is a [Docker container](https://quay.io/repository/luzifer/badge-gen) for it. Just start it and use your own URL
 
+For configuration options see [config.md](config.md). These need to be supplied in a YAML file:
+
+```yaml
+---
+
+key: value
+
+...
+```
+
 ### Popular buttons rebuilt
 
 Hint: To get the source just look into the source of this README.md

config.md

@@ -0,0 +1,4 @@
+| Key | Type | Description |
+| --- | ---- | ----------- |
+| github.personal_token | string | Token for Github auth to increase API requests |
+| github.username | string | Username for Github auth to increase API requests |

service_github.go

@@ -298,6 +298,8 @@ func (g githubServiceHandler) fetchAPI(ctx context.Context, path string, headers
 		}
 	}
 
+	// #configStore github.username - string - Username for Github auth to increase API requests
+	// #configStore github.personal_token - string - Token for Github auth to increase API requests
 	if configStore.Str("github.personal_token") != "" {
 		req.SetBasicAuth(configStore.Str("github.username"), configStore.Str("github.personal_token"))
 	}