Improvement to readme regarding --state option

1 files changed, 10 insertions, 0 deletions

diff --git a/readme.txt b/readme.txt
index 129d7c8..88c01f4 100644
--- a/readme.txt
+++ b/readme.txt
@@ -1,5 +1,10 @@
 
 
+This program takes AEC electoral data and runs the Single Transferable Vote
+algorithm on it to calculate election outcomes.
+
+
+
 To compile this program, the following dependencies are needed:
 
     ghc (of course)
@@ -38,6 +43,11 @@ Legislative Council data and more general STV data is a goal of future versions.
 
 
 
+Valid parameters for the '--state' option are 'NSW', 'QLD', 'VIC', 'TAS, 'SA',
+'WA', 'ACT', 'NT', all uppercase.
+
+
+
 Note that the number of count logs this program outputs differs from the
 number that the AEC provides. This is because the AEC's program merges a
 few more logs compared to this one, eg the initial count, and counts that