docs: moves library documentation to Go package doc.

This commit is contained in:
Steve Moyer
2024-11-29 09:08:28 -05:00
parent 9e9cc6dc92
commit 9565d56178
2 changed files with 21 additions and 19 deletions

View File

@@ -1,21 +1,3 @@
# go-varsig # go-varsig
`go-varsig` is an implementation of the `varsig` specification `go-varsig` implements v0.1.0 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

20
varsig.go Normal file
View File

@@ -0,0 +1,20 @@
// Package varsig implements v0.1.0 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.
//
// [section 3.1]: https://datatracker.ietf.org/doc/html/rfc7518#section-3.1
//
// [Varsig Specification]: https://github.com/ChainAgnostic/varsig
package varsig