google / coset

A set of Rust types for supporting COSE
Apache License 2.0
28 stars 16 forks source link

IANA example #64

Closed janosimas closed 1 year ago

janosimas commented 1 year ago

This is a feedback on the documentation, not on the implementation.

I miss having an example that uses ClaimsSet and IANA-defined values. I spent lot of time searching the repository to find and understand how to use the library correctly.

The first example in the docs uses a string payload, although it has value, it doesn't show many of the features of the library.

Also related to that, there are some type alias that are not always easy to find, like ClaimName. I think it would be worth to add "suggested alias" to the root types documentation, e.g. RegisteredLabelWithPrivate