readme: expand the scope and minor additions

The following have been added to the README:
- Build requirements
- Disclaimer
- Goals and non-goals
- License
main
Aydin Mercan 2021-11-02 12:11:23 +03:00
parent d014dca76d
commit c69930c738
1 changed files with 23 additions and 1 deletions

View File

@ -1,7 +1,29 @@
# Dumb JOSE
Insecure library for a set of insecure formats.
It aims to provide inflexible verification for cases where you unfortunately can't avoid touching JWT.
## Requirements
* Go *>= 1.17*
## Disclaimer
Don't use JWT. You don't need me to tell you about it.
Likewise, you shouldn't need me to tell you that you shouldn't use this library.
## Goals
* Just enough JWT for people to speak commonly encountered OAuth 2.0 and alike.
* Don't allow for any of the sharp edges.
* Allow for binding domain parameters as much as possible to the public keys.
## Non-Goals
* Signing capabilities.
* Anything that has to do with encryption or key exchange.
* Be 100% compliant with the standard.
## License
This repository is licensed under the `BSD-3-Clause`.
This repository is licensed under the `BSD-3-Clause`. Refer to [LICENSE](https://github.com/aydinmercan/dumb-jose/blob/main/LICENSE) for more information.