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

[Feature] Creation of a Comprehensive USAGE.md File #113

Open
ErikBavenstrand opened this issue Oct 9, 2023 · 0 comments
Open

[Feature] Creation of a Comprehensive USAGE.md File #113

ErikBavenstrand opened this issue Oct 9, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@ErikBavenstrand
Copy link
Collaborator

Is your feature request related to a problem? Please describe.
Currently, there is no USAGE.md file in the mleko library. This makes it difficult for new users to understand how to use the library effectively.

Describe the solution you'd like
A USAGE.md file should be created that provides comprehensive instructions on how to use the mleko library. This should include examples of common use cases, explanations of key functions and parameters, and any other information that would be helpful to users.

Describe alternatives you've considered
An alternative could be to include usage instructions in the README.md file. However, having a separate USAGE.md file would be more organized and easier for users to navigate.

Additional context
Having clear and comprehensive usage instructions is crucial for any library. This would greatly enhance the usability of the mleko library and help users get the most out of its features.

@ErikBavenstrand ErikBavenstrand added the enhancement New feature or request label Oct 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant