Update README

This commit is contained in:
Aram 🍐 2021-07-31 08:28:26 -04:00
parent dcad9c4093
commit 279b10b148
2 changed files with 14 additions and 0 deletions

View file

@ -11,6 +11,7 @@ A [Network UPS Tools](https://github.com/networkupstools/nut) (NUT) client libra
- Login with username and password - Login with username and password
- List UPS devices - List UPS devices
- List variables for a UPS device - List variables for a UPS device
- Connect securely with SSL (optional feature)
## Getting Started ## Getting Started
@ -78,3 +79,12 @@ fn main() -> nut_client::Result<()> {
Ok(()) 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.

View file

@ -15,6 +15,7 @@ Written using the [nut-client](https://github.com/aramperes/nut-client-rs) crate
- List variables for a UPS device - List variables for a UPS device
- Get variable value of a UPS device - Get variable value of a UPS device
- List clients connected to a UPS device - List clients connected to a UPS device
- Connect securely with SSL
## Installation ## Installation
@ -58,6 +59,9 @@ However, there are also some additions:
```bash ```bash
# Enable network debugging (global flag). # Enable network debugging (global flag).
ruspc -D ruspc -D
# Enable SSL
rupsc -S
``` ```
## Pronunciation ## Pronunciation