From 1bb4c678181274d7c1e43bda8f963aa9dd7ff7a5 Mon Sep 17 00:00:00 2001
From: Brian Nelson <brian@briannelson.dev>
Date: Sat, 24 Oct 2026 17:36:32 -0400
Subject: [PATCH] updated README

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/README.md b/README.md
index 8e637af..1f2db11 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,40 @@
 # 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.
 
+> [!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
+### macOS Apple Silicon
 1. Open a terminal and run
 ```bash
 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
 
+### 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
 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 |