search

jwir3 / arbitrator

A synchronization engine for ArbiterSports to Google Calendar
GNU General Public License v3.0
3 stars 0 forks source link

Add a README with basic setup instructions #27

Closed jwir3 closed 9 years ago

jwir3 commented 9 years ago

There is no user documentation for arbitrator. We should add some to a README file. At the very least, we should have:

  1. How to use the app on glasstowerstudios.com
  2. How to download the source code and utilize it.
    1. What needs to be changed in the API key, and how to do it, to authorize from your own server.
  3. Warnings about missing games.
  4. Caveats about functionality not working for anything other than hockey.
  5. How to get in touch and submit reports.