From 3166db6742b558994a43cf17976f2528b11861ed Mon Sep 17 00:00:00 2001 From: Conrad Kleinespel Date: Mon, 14 Mar 2022 20:01:21 +0100 Subject: [PATCH] Update rpassword docs --- Cargo.toml | 2 +- README.md | 5 +++-- src/lib.rs | 4 ++-- src/rpassword/all.rs | 2 +- 4 files changed, 7 insertions(+), 6 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 1186fa4..9bcdcbb 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "rpassword" -version = "6.0.0" +version = "6.0.1" authors = ["Conrad Kleinespel "] description = "Read passwords in console applications." license = "Apache-2.0" diff --git a/README.md b/README.md index 7341e22..8914f84 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Rustastic Password -`rpassword` makes it easy to read passwords in a console application on all platforms, Unix and Windows alike. +`rpassword` makes it easy to read passwords in a console application on all platforms, Unix, Windows, WASM, etc. `rpassword` is made available free of charge. You can support its development through [Liberapay](https://liberapay.com/conradkleinespel/) 💪 @@ -10,7 +10,7 @@ Add `rpassword` as a dependency in Cargo.toml: ```toml [dependencies] -rpassword = "5.0" +rpassword = "6.0" ``` See examples and docs at [https://docs.rs/rpassword](https://docs.rs/rpassword). @@ -30,6 +30,7 @@ Here's a list of existing `rpassword` contributors: * [@equalsraf](https://github.com/equalsraf) * [@Heliozoa](https://github.com/Heliozoa) * [@JanLikar](https://github.com/JanLikar) +* [@john-sharratt](https://github.com/john-sharratt) * [@joshuef](https://github.com/joshuef) * [@longshorej](https://github.com/longshorej) * [@nicokoch](https://github.com/nicokoch) diff --git a/src/lib.rs b/src/lib.rs index f2fa949..f98e557 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,5 +1,5 @@ -//! This library makes it easy to read passwords in a console application on all platforms, Unix and -//! Windows alike. +//! This library makes it easy to read passwords in a console application on all platforms, Unix, +//! Windows, WASM, etc. //! //! Here's how you can read a password: //! ```no_run diff --git a/src/rpassword/all.rs b/src/rpassword/all.rs index 20a0062..5d5bde0 100644 --- a/src/rpassword/all.rs +++ b/src/rpassword/all.rs @@ -224,7 +224,7 @@ pub fn prompt_password_from_bufread( .and_then(|_| read_password_from_bufread(reader)) } -/// Prompts on the TTY and then reads a password from stdin +/// Prompts on the TTY and then reads a password from TTY pub fn prompt_password(prompt: impl ToString) -> std::io::Result { print_tty(prompt.to_string().as_str()).and_then(|_| read_password()) }