Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme: Better documentation of the configuration options #21

Open
neumantm opened this issue Feb 23, 2021 · 3 comments
Open

Readme: Better documentation of the configuration options #21

neumantm opened this issue Feb 23, 2021 · 3 comments

Comments

@neumantm
Copy link

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

@neumantm
Copy link
Author

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

@pinepain
Copy link
Owner

pinepain commented Mar 9, 2021

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?

@neumantm
Copy link
Author

neumantm commented Mar 9, 2021

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants