docs: add acknowledgements section

Fixes: https://github.com/zkat/miette/issues/24
This commit is contained in:
Kat Marchán 2021-08-21 23:08:11 -07:00
parent 20bb3db3fa
commit ffee3753f0
No known key found for this signature in database
GPG Key ID: AEB529C08A3C7E9E
1 changed files with 19 additions and 0 deletions

View File

@ -35,6 +35,7 @@ diagnostic error code: ruget::api::bad_json
- [... in application code](#-in-application-code)
- [... in `main()`](#-in-main)
- [... snippets](#-snippets)
- [Acknowledgements](#acknowledgements)
- [License](#license)
## Features
@ -258,6 +259,24 @@ pub struct MyErrorType {
}
```
## Acknowledgements
`miette` was not developed in a void. It owes enormous credit to various other projects and their authors:
- [`anyhow`](http://crates.io/crates/anyhow) and
[`color-eyre`](https://crates.io/crates/color-eyre): these two enormously
influential error handling libraries have pushed forward the experience of
application-level error handling and error reporting. `miette`'s
`DiagnosticReport` type is an attempt at a very very rough version of their
`Report` types.
- [`thiserror`](https://crates.io/crates/thiserror) for setting the standard
for library-level error definitions, and for being the inspiration behind
`miette`'s derive macro.
- `rustc` and [@estebank](https://github.com/estebank) for their state-of-the-art
work in compiler diagnostics.
- [`ariadne`](https://crates.io/crates/ariadne) for pushing forward how
_pretty_ these diagnostics can really look!
## License
`miette` is released to the Rust community under the [Apache license 2.0](./LICENSE).