Readme: Better documentation of the configuration options

Question

Readme: Better documentation of the configuration options

neumantm opened this issue 4 years ago · 3 comments

I feel it would help, if the various environment variables which can be set to configure the tool, were better documented in the readme.

Answer 1 · 2021-02-23T22:56:51.000Z

I acutually found the config.go just now. Maybe just link to that from the README

Answer 2 · 2021-03-09T10:08:25.000Z

Hi @neumantm, thanks for finding time to raise this concern. Indeed, the docs supposed to be better.

Do you think the regular --help output (in advance to the configuration example with env variables) would be sufficient to give a hint on how to operate this tool for newcomers? Do you have some other suggestions?

Answer 3 · 2021-03-09T11:45:53.000Z

Yeah I suppose, that would already help a lot.
Maybe, addtionally add a link to the config.go, because the README might get outdated.