Skip to content

Commit 6553522

Browse files
committed
docs: clarify lib description, update README
It's a lib, not a tool, and we don't typically use it for OpenSSL, but rather other crates trying to emulate OpenSSL's behavior. We also don't need to help guide through adding a dependency to a Rust project. Most users shouldn't be touching this crate directly, and if they need to, are assumed to be a Rust developer familiar with `cargo`.
1 parent 5e18d53 commit 6553522

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

Cargo.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ license = "MIT OR Apache-2.0"
66
repository = "https://github.com/rustls/openssl-probe"
77
homepage = "https://github.com/rustls/openssl-probe"
88
description = """
9-
Tool for helping to find SSL certificate locations on the system for OpenSSL
9+
A library for helping to find system-wide trust anchor ("root") certificate
10+
locations based on paths typically used by `openssl`.
1011
"""
1112
readme = "README.md"
1213
edition = '2021'

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
# openssl-probe
22

3-
Tool for helping to find SSL certificate locations on the system for OpenSSL
3+
A library for helping to find system-wide trust anchor ("root") certificate
4+
locations based on paths typically used by `openssl`.
5+
6+
For most users, [`rustls-platform-verifier`][] or [`rustls-native-certs`][]
7+
are more convienient and robust ways to have TLS connections respect system
8+
configuration. This is a lower-level library.
49

510
[![Crates.io](https://img.shields.io/crates/v/openssl-probe.svg?maxAge=2592000)](https://crates.io/crates/openssl-probe)
611
[![docs.rs](https://docs.rs/openssl-probe/badge.svg)](https://docs.rs/openssl-probe/)
712

8-
## Usage
9-
10-
First, add this to your `Cargo.toml`:
13+
[`rustls-platform-verifier`]: https://crates.io/crates/rustls-platform-verifier
14+
[`rustls-native-certs`]: https://crates.io/crates/rustls-native-certs
1115

12-
```toml
13-
[dependencies]
14-
openssl-probe = "0.1.6"
15-
```
16-
17-
Then add this to your crate:
16+
## Usage
1817

1918
```rust
2019
fn main() {

0 commit comments

Comments
 (0)