Add example to the README.md file#270
Merged
KodrAus merged 1 commit intobitflags:mainfrom Apr 20, 2022
Merged
Conversation
Member
|
Thanks @tiaanl! This looks good to me, but for the README it might be good to put some comments inline with the |
6df2ce2 to
decb0f6
Compare
Contributor
Author
|
@KodrAus I copied a small comment from the |
Contributor
Author
|
@KodrAus Thanks for the approval. I'm not sure why all the checks are failing. I only changed the README 😕 Any suggestions? |
Member
|
That's just changes to Rust's compiler messages so nothing to worry about here. I've fixed those up so will merge this one in. Thanks again! |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Add a simple example to the README.md file to show the capabilities of the crate. The README is displayed in many places where developers are evaluating its use and having an example is always useful.