diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a240b06
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# Audio keylogger
+
+inspired by https://ctftime.org/task/17576
+
+# Generator
+
+Generates a wav file with keyboard sounds matching the privided input string. Only supports a-z and spacey, and should at least contain 250 characters to gain a statistically significant sample.
+
+```python3 ./generator.py "<input>```
+
+# Solver
+
+Minimalistic solver example that samples the audio stream, and on detecting the start/end of sounds, calculates the average volume of that keystroke and maps it onto an arbitrary mono-alphabetic alphabet. The resulting "substitution cipher" can then be put through a solver to find the original text.
+See `test.sh` for an example.