From 279b10b1482a048b396d0dc6bb04e440a39dfadd Mon Sep 17 00:00:00 2001 From: Aram Peres Date: Sat, 31 Jul 2021 08:28:26 -0400 Subject: [PATCH] Update README --- README.md | 10 ++++++++++ rupsc/README.md | 4 ++++ 2 files changed, 14 insertions(+) diff --git a/README.md b/README.md index ac6b3a4..dbf4c28 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ A [Network UPS Tools](https://github.com/networkupstools/nut) (NUT) client libra - Login with username and password - List UPS devices - List variables for a UPS device +- Connect securely with SSL (optional feature) ## Getting Started @@ -78,3 +79,12 @@ fn main() -> nut_client::Result<()> { Ok(()) } ``` + +## SSL + +You can turn on SSL support by adding `.with_ssl(true)` in the `ConfigBuilder`. +This requires the `ssl` feature, which uses `rustls` under the hood. + +Note that this crate turns off all certificate validation at the moment, effectively +giving a false sense of security. If you'd like to contribute to this, see issue #8. + diff --git a/rupsc/README.md b/rupsc/README.md index 145af59..e48e708 100644 --- a/rupsc/README.md +++ b/rupsc/README.md @@ -15,6 +15,7 @@ Written using the [nut-client](https://github.com/aramperes/nut-client-rs) crate - List variables for a UPS device - Get variable value of a UPS device - List clients connected to a UPS device +- Connect securely with SSL ## Installation @@ -58,6 +59,9 @@ However, there are also some additions: ```bash # Enable network debugging (global flag). ruspc -D + +# Enable SSL +rupsc -S ``` ## Pronunciation