updated README

This commit is contained in:
2026-10-24 17:37:42 -04:00
parent 1bb4c67818
commit ce19686ec8

View File

@@ -2,7 +2,8 @@
Rusty PW is a rust based generator for simple passwords. The list of words can be found at [./words.txt](./words.txt). This is a list of 200, 5 letters words that are school appropriate. Rusty PW is a rust based generator for simple passwords. The list of words can be found at [./words.txt](./words.txt). This is a list of 200, 5 letters words that are school appropriate.
> [!WARNING] > [!WARNING]
> I do not recommend using these word-number pairs as long term security. > I do not recommend using these word-number pairs as long term security.
>
> This project was built for a niche instance where I needed to make up a lot of these types of pairs. > This project was built for a niche instance where I needed to make up a lot of these types of pairs.
## Installation ## Installation
@@ -47,7 +48,7 @@ Here is a list of all the options available. None of these are required and a si
| `--out` | Output file name | `rusty-pw` | No | | `--out` | Output file name | `rusty-pw` | No |
## Useage ## Usage
```bash ```bash
Random word + number generator Random word + number generator