two-horse-race/README

TWO-HORSE RACE
==============

Generates a human-readable plain text stream of election results from JSON input.


Usage
-----

Assuming `twohorserace` is in your $PATH and executable:

Read JSON from a file:

	$ twohorserace elections.json

Read JSON from STDIN:

	$ cat elections.json | twohorserace --


Installation
------------

Tested and working with Ruby 3.1.2, which is currently the latest stable
release.

Tested and working with Ruby 2.6.10, which is currently the oldest
version supported by the Ruby project.

Will probably work with earlier versions.

There are no other dependencies.

No gems outside the standard library. No databases are used. No
environment variables.

There isn't a Gemfile. You don't need Bundler.


Example files
-------------

elections.json is an example input file.
elections.txt is an example output file.

These files are for demonstration purposes only. Do not rely on them as
accurate representations of actual election results.


Roadmap
-------

Election summary: seats, votes, candidates per party.
Improve vote/voter share percentages in district views.


Repository
----------

https://git.adrianshort.org/adrian/two-horse-race


Maintainer
----------

Adrian Short <adrian@adrianshort.org>