From 6f00eb6fd7792ec41518fe50c1803a24935f94f7 Mon Sep 17 00:00:00 2001
From: ryan <ryan@distrust.co>
Date: Wed, 16 Aug 2023 18:27:55 -0500
Subject: [PATCH] keyfork-mnemonic-generate: add README

---
 keyfork-mnemonic-generate/README.md | 5 +++++
 1 file changed, 5 insertions(+)
 create mode 100644 keyfork-mnemonic-generate/README.md

diff --git a/keyfork-mnemonic-generate/README.md b/keyfork-mnemonic-generate/README.md
new file mode 100644
index 0000000..4fd72fa
--- /dev/null
+++ b/keyfork-mnemonic-generate/README.md
@@ -0,0 +1,5 @@
+This program is designed to generate a 12- or 24-word mnemonic using system
+entropy on an offline, post-5.4-kernel Linux system. For testing purposes, the
+command may be run in an insecure environment using `SHOOT_SELF_IN_FOOT=1`. The
+program may be passed a seed size as the first and only argument, and only
+supports seed sizes of 128 bits or 256 bits, for 12 and 24 word mnemonics.