docs: add initial README file

This commit is contained in:
Steve Moyer
2024-11-29 08:21:26 -05:00
parent 7b31ac0149
commit 9e9cc6dc92

21
README.md Normal file
View File

@@ -0,0 +1,21 @@
# go-varsig
`go-varsig` is an implementation of the `varsig` specification
## Algorithm naming
While there is no strict need for compatibility with JWA/JWT/JWE/JWS, all
attempts are made to keep the algorithm names here consisten with the
table provided in section 3.1 of RFC7518 titled "JSON Web Algorithms. In
cases where there is no equivalent name for an algorithm, a best-effort
attempt at creating a name in the spirit of that specification is made.
It should also be noted that algorithm in this context might in fact be a
pseudonym - for cryptographical signing algorithms that require the signed
data to be hashed first, these names commonly refer to the combination of
that signing algorithm and the hash algorithm.
## References
https://github.com/ChainAgnostic/varsig
https://datatracker.ietf.org/doc/html/rfc7518#section-3.1