Update tests and docs #13
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
In order to ensure test descriptions match what they are testing, this commit replaces occurences of hamc with hmac as this is the proper name of the message integrity algorithm.
In order to remove a deprecated and unused crate from the dependencies, this commit removes block_modes. This crate was deprecated in favor of the crate collection under [RustCrypto](https://github.com/RustCrypto/block-modes). It's also currently not being used in the source anywhere.
In order to simplify documentation, this commit moves most of the documentation directly into the README.md. Additionally, to avoid duplication, this commit pulls in the README.md into the crate docs. This allows one source of truth for documentation and a common experience between viewing the crate on github, crates.io, and docs.rs.
endoze
force-pushed
the
update-tests-and-docs
branch
from
04d787d to
5f7b3b8
Compare
|
Thanks you for this contribution! |
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.
In order to simplify documentation, this PR moves most of the
documentation directly into the README.md. Additionally, to avoid
duplication, this PR pulls in the README.md into the crate docs.
This allows one source of truth for documentation and a common
experience between viewing the crate on github, crates.io, and docs.rs.
Additionally, this PR removes an unused/deprecated crate (block_modes)
and fixes minor spelling errors in the tests.