document the crypto package #22
Merged
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.
This pull request introduces comprehensive documentation and a practical example for the
cryptopackage, making it easier for developers to understand and use its features. The changes focus on explaining the package's goals, supported algorithms, and providing a step-by-step usage guide.Documentation improvements:
Readme.mdfor thecryptopackage, describing its purpose, the problems it solves compared to standard Go crypto packages, and listing supported cryptographic algorithms and their capabilities. The README includes a clear example workflow covering key generation, serialization, signing, key exchange, and configuration management usingvarsig.Examples and usage:
crypto/_example/example_test.gothat demonstrates real-world usage of the package, including key generation, serialization, signing and verifying messages, key exchange, and use of signing configuration (varsig). This example closely matches the one provided in the README for consistency and clarity.Note
Improves developer-facing documentation for
cryptowithout changing behavior.crypto/Readme.mdwith package overview, usage example, and supported algorithms tablecrypto/example_test.goshowcasing key generation, serialization, signing/verification, key exchange, andvarsigusagecrypto/public.go,crypto/hash.go,crypto/options.go,crypto/jwk/*, and_testsuite/testsuite.goWritten by Cursor Bugbot for commit 4eda230. This will update automatically on new commits. Configure here.