Skip to content

Commit

Permalink
Update rpassword docs
Browse files Browse the repository at this point in the history
  • Loading branch information
conradkleinespel committed Mar 14, 2022
1 parent 096c1c8 commit 3166db6
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "rpassword"
version = "6.0.0"
version = "6.0.1"
authors = ["Conrad Kleinespel <conradk@conradk.com>"]
description = "Read passwords in console applications."
license = "Apache-2.0"
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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/) 💪

Expand All @@ -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).
Expand All @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/rpassword/all.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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<String> {
print_tty(prompt.to_string().as_str()).and_then(|_| read_password())
}
Expand Down

0 comments on commit 3166db6

Please sign in to comment.