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

More examples and documentation #90

Open
ilyakaznacheev opened this issue May 27, 2021 · 2 comments
Open

More examples and documentation #90

ilyakaznacheev opened this issue May 27, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@ilyakaznacheev
Copy link

The library itself is great and powerful, but it's hard to understand all of the options and possibilities without reading the sources.

Please add more readable documentation about its features - tags, flags, integration options, etc.

@cristaloleg
Copy link
Member

Any particular examples? Feel free to open PR btw.

@ilyakaznacheev
Copy link
Author

ilyakaznacheev commented May 27, 2021

Like

  • what the whole list of supported tags and their options?
  • how to use different loader config flags and combine them?
  • how exactly to integrate with spf13/cobra and maybe with common help output?

etc.

The main reason for opening this issue is as a newbie developer I want to open the docs and know how to use the library in the existing project without reading the sources. I also want to see the whole list of its features to compare with other configuration libraries to choose the better fit for my needs.

@cristaloleg cristaloleg changed the title Poor documentation More examples and documentation May 27, 2021
@cristaloleg cristaloleg added the documentation Improvements or additions to documentation label Feb 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants