Move crate documentation to README and add code example #231
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
hug-dev
reviewed
Oct 30, 2024
hug-dev
previously approved these changes
Oct 30, 2024
Signed-off-by: Wiktor Kwapisiewicz <wiktor@metacode.biz>
wiktor-k
force-pushed
the
wiktor/better-readme
branch
from
f4199d3 to
5194772
Compare
hug-dev
approved these changes
Nov 12, 2024
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.
The old root module documentation referred to the unused "new" module. This PR cleans up the docs a bit and adds code example which gets executed as part of the unit tests.