Add usage to readme

joelpurra · Jan 25, 2014 · 99613ce · 99613ce
1 parent 4f88d76
commit 99613ce
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -2,7 +2,14 @@
 
 Using [open data dumps](http://parltrack.euwiki.org/dumps) from [Parltrack](http://parltrack.euwiki.org/) to analyze erroneous, and subsequently corrected, votes by Members of the European Parliaments.
 
-Download [ep_votes.json.xz](http://parltrack.euwiki.org/dumps/ep_votes.json.xz) and unpack it somewhere. The unpacked `ep_votes.json` file is big (500MB+); please see [the schema](http://parltrack.euwiki.org/dumps/schema.html) for an overview.
+
+
+## Usage
+
+1. Download [ep_votes.json.xz](http://parltrack.euwiki.org/dumps/ep_votes.json.xz) and unpack it somewhere. The unpacked `ep_votes.json` file is big (500MB+); please see [the schema](http://parltrack.euwiki.org/dumps/schema.html) for an overview.
+1. Run the scripts.
+  - `extract-and-prepare.sh [indir [outdir]]` creates JSON dumps with erroneous votes.
+  - `vote-counts.sh [indir [outdir]]` creates lists of number of votes.
 
 
 ## Todo