From: Dylan Lloyd <dylan@dylansserver.com>
Date: Mon, 30 Jun 2014 02:56:18 +0000 (-0700)
Subject: s/txt/md/
X-Git-Url: https://disinclined.org/git/?a=commitdiff_plain;h=d732622febc66906e11762c6dd494dc00615bc7e;p=simpletimingattack.git

s/txt/md/
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..26c75d4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Simple Timing Attack
+
+This program implements a simple [timing attack](http://en.wikipedia.org/wiki/Timing_attack). It measures the execution time of a target program over a number of iterations, rotating through a character set and appending the fastest character to the result.
+
+## Requirements:
+
+    librt (with clock_gettime implemented)
+
+Note: OSX [does not currently implement](http://stackoverflow.com/questions/5167269/clock-gettime-alternative-in-mac-os-x) `clock_gettime`
+
+## Compilation:
+
+    gcc -lrt ./timingattack -o timingattack
+
+## Usage:
+
+    Usage: timingattack [options...] <invocation>
+    Options:
+      --l, --length          specify password length
+      --i, --iterations      specify iterations per character
+      --c, --charset         specify possible password characters (alphanum default)