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

Adding documentation that is provided in Readme to hex #44

Open
the-shank opened this issue Sep 6, 2017 · 1 comment
Open

Adding documentation that is provided in Readme to hex #44

the-shank opened this issue Sep 6, 2017 · 1 comment

Comments

@the-shank
Copy link

Thanks for this very useful library!

As it currently stands, all the usage related documentation is provided in the README file and none of that is reflected in hexdocs. It would be useful to add this documentation or at-least some part of it to the docs for the library.

Please let me know if this sounds like a good idea. I shall send a PR accordingly.

@isaacsanders
Copy link

I think this is a good idea. Documenting it to match the sort of documentation found for the :console logger backend could make it easier to discover the documentation.

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