updated README

This commit is contained in:
2026-10-24 17:36:32 -04:00
parent 2f71a281f3
commit 1bb4c67818

View File

@@ -1,13 +1,40 @@
# rusty-pw # rusty-pw
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]
> 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.
## Installation ## Installation
### macOS Apple Silicon
1. Open a terminal and run 1. Open a terminal and run
```bash ```bash
curl -fsSL https://git.briannelson.dev/brian/rusty-pw/raw/branch/main/install.sh | sh curl -fsSL https://git.briannelson.dev/brian/rusty-pw/raw/branch/main/install.sh | sh
``` ```
2. Run `rusty-pw` to generate your first word-number pair 2. Run `rusty-pw` to generate your first word-number pair
### NixOS Flakes
1. Add the flake to your inputs
```nix
rusty-pw = {
url = "git+https://git.briannelson.dev/brian/rusty-pw";
inputs.nixpkgs.follows = "nixpkgs";
};
```
2. Add the input to your configuration as an overlay
```nix
{ inputs, pkgs, ... }:
{
nixpkgs.overlays = [
inputs.rusty-pw.overlays.default
];
environment.systemPackages = with pkgs; [ rusty-pw ];
}
```
3. Rebuild your system and run `rusty-pw` to generate your first word-number pair
## Options ## Options
Here is a list of all the options available. None of these are required and a single word with 4 digits can be generated with `rusty-pw` Here is a list of all the options available. None of these are required and a single word with 4 digits can be generated with `rusty-pw`
| Option | Description | Default | Required | | Option | Description | Default | Required |