From a00ffe06c27677cfdcc17f97e77ad31913f1dfdd Mon Sep 17 00:00:00 2001
From: David Florness <david@florness.com>
Date: Mon, 8 Jun 2020 23:45:29 -0600
Subject: [PATCH] Update README

---
 README.md | 84 ++++++++++---------------------------------------------
 1 file changed, 14 insertions(+), 70 deletions(-)

diff --git a/README.md b/README.md
index 620a4d2..5f65b9d 100644
--- a/README.md
+++ b/README.md
@@ -5,11 +5,12 @@ preventing double-voting.  Voter privacy is achieved via the homomorphic secret
 sharing system outlined
 [here](https://en.wikipedia.org/wiki/Homomorphic_secret_sharing#Example:_decentralized_voting_protocol)
 and double-voting is prevented by a STARKs zero-knowledge proof as described
-[here](https://vitalik.ca/general/2017/11/09/starks_part_1.html).
+[here](https://vitalik.ca/general/2017/11/09/starks_part_1.html).  Voters'
+computers communicate with each other directly over a peer-to-peer network.
+While there is a "master" node that decides what the candidates of the election
+are, it does not have any privileges once voting begins.
 
-The zero-knowledge implementation is not entirely finished.  All of this is
-planned to be done over a peer-to-peer network; however, at the moment there is a
-centralized "bulletin" that relays traffic between peers.
+The zero-knowledge implementation is not entirely finished.
 
 tallyard is very much a work-in-progress and is only useful for elections where
 everyone is voting simultaneously, such as a club election, [which it was
@@ -18,81 +19,24 @@ for](https://mailman.mines.edu/pipermail/lug/2020-April/000573.html).
 
 # Usage
 
-Ensure you have the [Racket](https://racket-lang.org) programming language
-installed.  Then, install tallyard's dependencies:
+Ensure you have the [Go](https://golang.org) programming language
+installed.  Then:
 
 ```sh
 $ cd /path/to/tallyard/repo
-$ raco pkg install
+$ make
 ```
 
-## Bulletin
+# Why Go?
 
-The bulletin is a simple Racket-powered RESTful HTTP server to which voters
-(i.e. peers) connect to participate in an election.  As the bulletin is running,
-it can be given commands to alter the election.
-
-If you with to run the bulletin, you need to setup a host with an HTTP endpoint
-that accepts a JSON body containing "username" and "password" keys and returns
-the JSON string "success" if the corresponding "username" and "password" values
-correspond to a valid login.
-
-In the following code in bulletin.rkt, replace "AUTH-HOST-HERE" with the
-aforementioned host and "/auth/route/here" with the endpoint.  I realize this is
-cumbersome, and I plan to provide an easier way to configure this.
-
-```racket
-(define (auth username password)
-  (equal? (hash-ref
-           (json-response-body
-            (post (update-ssl (update-host json-requester
-                                           "AUTH-HOST-HERE")
-                              #t)
-                  "/auth/route/here"
-                  #:data
-                  (jsexpr->string (hasheq 'username username
-                                          'password password))))
-           'result)
-          "success"))
-```
-
-The bulletin can then be started with
-
-```sh
-$ racket bulletin.rkt
-```
-
-## Voter client
-
-If you're a voter who wants to participate, do
-
-```sh
-$ racket client.rkt
-```
-
-and enter the correct bulletin host and login information when prompted.
-
-# Why Racket?
-
-I've always had a soft spot for LISPs[^1] and needed an excuse to try [Typed
-Racket](https://docs.racket-lang.org/ts-guide/).  tallyard began as a quick
-hackathon project, but turned into the project I worked on in my free time once
-I became obsessed.
-
-[^1]: I still don't know why
-
-However, Racket is not the ideal language for networking and fast cryptography.
-Defining functional tree-like structures (like Merkle trees) in Racket is quite
-ugly without something like [recursion
-schemes](https://blog.sumtypeofway.com/posts/introduction-to-recursion-schemes.html),
-which are not implemented in Racket yet.
+- concurrency
+- libp2p
 
 # Future Work
 
-- utilize [libp2p](https://libp2p.io/) for peer-to-peer networking.  This will
-  require either rewriting tallyard it Golang or using FFIs.
-- support multiple authentication systems.  First on the list is [Matrix](https://matrix.org/)
-- [Matrix](https://matrix.org/) bots for voting on topics in matrix chat rooms
+- support authentication systems.  First on the list is
+  [Matrix](https://matrix.org/) accounts
+- [Matrix](https://matrix.org) bots for voting on topics in matrix chat rooms
 - finish the zero-knowledge proof implementation
 
 # Origin of the name
-- 
2.38.4