Add helper function instructions to readme #14
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
olivere
approved these changes
Sep 13, 2024
|
I think it's a good first step. Giving a rough idea of how it works and delegating to the examples is fine for me. Do you want to add something, or are you OK with me to merge it? |
|
Just pushed up some documentation for Config. I'm happy to merge and we can improve the docs more in future |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I have added instructions for the new helper function part of the library to the readme.
I think this is likely to be the most common way people will use this library so I have put it at the top.
I've left the old instructions as they are for now. I'd appreciate any input, writing documentation can be quite hard!