Skip to content

Commit fa5a165

Browse files
committed
Rename feature flags to be more idiomatic
1 parent 86fba06 commit fa5a165

3 files changed

Lines changed: 10 additions & 9 deletions

File tree

Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ all = "deny"
3838

3939
[features]
4040
ring = ["rustls/ring", "rustls/logging", "rustls/std", "rustls/tls12"]
41-
aws-lc-rs = ["rustls/aws_lc_rs", "rustls/logging", "rustls/std", "rustls/tls12"]
41+
aws_lc_rs = ["rustls/aws_lc_rs", "rustls/logging", "rustls/std", "rustls/tls12"]
4242
experimental = []
43-
default = ["aws-lc-rs"]
43+
default = ["aws_lc_rs"]
4444

4545
[dependencies]
4646
async-trait = "0.1.88"

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,9 @@ Known authentication back-ends:
5656

5757
## Cryptographic Providers
5858

59-
libunftp supports two cryptographic providers through feature flags:
59+
These two feature flags can be used to select the cryptographic provider:
6060

61-
- `aws-lc-rs` (default): Uses AWS-LC through rustls for cryptographic operations
61+
- `aws_lc_rs` (default): Uses AWS-LC through `rustls` for cryptographic operations
6262
- `ring`: Uses the ring crate for cryptographic operations
6363

6464
To use a specific provider, enable the corresponding feature in your `Cargo.toml`:
@@ -67,12 +67,13 @@ To use a specific provider, enable the corresponding feature in your `Cargo.toml
6767
[dependencies]
6868
libunftp = { version = "0.20.3", features = ["ring"] } # Use ring
6969
# or
70-
libunftp = { version = "0.20.3", features = ["aws-lc-rs"] } # Use aws-lc-rs (default)
70+
libunftp = { version = "0.20.3", features = ["aws_lc_rs"] } # Use aws-lc-rs (default)
7171
```
7272

7373
The default provider is `aws-lc-rs` for backward compatibility. Choose the provider that best fits your needs:
74-
- `ring`: More widely used, good for general-purpose applications
75-
- `aws-lc-rs`: Optimized for AWS environments, good for cloud deployments
74+
75+
- [`ring`](https://crates.io/crates/ring): More widely used, good for general-purpose applications
76+
- [`aws-lc-rs`](https://crates.io/crates/aws-lc-rs): Optimized for AWS environments, good for cloud deployments
7677

7778
## Prerequisites
7879

crates/unftp-sbe-fs/Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ readme = "README.md"
2020

2121
[features]
2222
ring = ["libunftp/ring"]
23-
aws-lc-rs = ["libunftp/aws-lc-rs"]
24-
default = ["aws-lc-rs"]
23+
aws_lc_rs = ["libunftp/aws_lc_rs"]
24+
default = ["aws_lc_rs"]
2525

2626
[dependencies]
2727
async-trait = "0.1.88"

0 commit comments

Comments
 (0)