From ef9638ce293da54dd115a34b91b732befb7ddfc1 Mon Sep 17 00:00:00 2001
From: Ole Morud <ole.morud@gmail.com>
Date: Fri, 23 Aug 2024 00:39:09 +0200
Subject: [PATCH] Add README

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9df4049
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+
+# Vigenère cipher solver
+
+Uses index of coincidence and frequency analysis to find Vigenère cipher keys
+from ciphertexts
+
+## Build
+
+```bash
+make
+```
+
+## Example usage
+
+```
+./build/solve txt/shakespeare-encrypted.txt | head -c 1024
+```
+
+## References
+
+[Vigenère cipher](https://en.wikipedia.org/wiki/Vigen%C3%A8re_cipher)
+
+[Index of Coincidence](https://en.wikipedia.org/wiki/Index_of_coincidence)
+
+[Frequency analysis](https://en.wikipedia.org/wiki/Frequency_analysis)
+