summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJoe Robinson <joe@mumsnet.com>2014-07-18 18:32:33 +0100
committerJoe Robinson <joe@mumsnet.com>2014-07-18 18:32:33 +0100
commit2b2d6732707ff24a50f672466f8b9fbb40f90653 (patch)
tree25c6a386ec81182afb06eb153caabf1356f9f71b /README
parent70b4b1dc65bfd493088443c20c4670a62c06f317 (diff)
Updated readme
Diffstat (limited to 'README')
-rw-r--r--README26
1 files changed, 23 insertions, 3 deletions
diff --git a/README b/README
index b2725f9..2d5921b 100644
--- a/README
+++ b/README
@@ -1,11 +1,31 @@
blavote
+Work in progress
+
This program can be used to create polls, and allow users to vote on
them.
-Usage: go run blavote.go
+Usage:
+
+To add a poll:
+
+blavote -u username -a "poll question" option1 option2..
+
+e.g:
+
+blavote -u wjoe -a "Indent with tabs or spaces?" Tabs Spaces
+
+To vote on a poll:
-(or compile with go build blavote.go, and execute blavote)
+blavote -u username pollId vote
+
+e.g:
+
+blavote -u wjoe 1 spaces
+
+Compiling:
+
+go install http://www.blatech.co.uk/wjoe/blavote
Requirements:
Go (to compile, or run from source)
@@ -18,4 +38,4 @@ Written in Go
Libraries used:
http://www.github.com/mxk/go-sqlite/sqlite3
-
+https://github.com/jessevdk/go-flags