Use README as crate docs #537
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
newpavlov
commented
Jan 10, 2024
| simd_asm = ["simd_opt"] | ||
| #simd = [] | ||
| #simd_opt = ["simd"] | ||
| #simd_asm = ["simd_opt"] |
There was a problem hiding this comment.
We probably should finish #228 before publishing blake2 v0.11.
There was a problem hiding this comment.
Yeah, definitely been meaning to do it. Would be great to get it over the finish line.
tarcieri
reviewed
Jan 10, 2024
tarcieri
reviewed
Jan 10, 2024
|
|
||
| <img src="https://raw.githubusercontent.com/RustCrypto/meta/master/img/hashes/sha2.png" width="480px"> |
There was a problem hiding this comment.
I think most users of the crate (and thus readers of the doc) would not care for this pretty picture. :)
There was a problem hiding this comment.
I can add it after examples if you want.
tarcieri
reviewed
Jan 10, 2024
tarcieri
approved these changes
Jan 10, 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.
Moves all crate-level docs to appropriate READMEs. Additionally, adds some cleanups made possible by migration to
hybrid-arrayandhex-literal v0.4.