Skip to content

Commit

Permalink
docs: add suitability warning to top-level README
Browse files Browse the repository at this point in the history
We already had a version of this warning in the webpki-roots crate's
top-level rustdoc. This ports the warning to the top-level git README so
that it is visible to folks evaluating the crate in GitHub as well.
  • Loading branch information
cpu committed Feb 2, 2024
1 parent 84ec9d6 commit 30feec0
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@ Inspired by [certifi.io](https://certifi.io/en/latest/).
[![webpki-roots](https://github.com/rustls/webpki-roots/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/rustls/webpki-roots/actions/workflows/build.yml)
[![Crate](https://img.shields.io/crates/v/webpki-roots.svg)](https://crates.io/crates/webpki-roots)

# Warning

This library is suitable for use in applications that can always be recompiled and instantly deployed.
For applications that are deployed to end-users and cannot be recompiled, or which need certification
before deployment, consider a library that uses the platform native certificate verifier such as
[rustls-platform-verifier]. This has the additional benefit of supporting OS provided CA constraints
and revocation data.

[rustls-platform-verifier]: https://docs.rs/rustls-platform-verifier

# License
The underlying data is MPL-licensed, and `webpki-roots/src/lib.rs`
is therefore a derived work.
Expand Down

0 comments on commit 30feec0

Please sign in to comment.