Add readme and authorship variables

README.md

@@ -1,3 +1,23 @@
 # bcexparse
 
-FF6 BCEX Spoiler Log to JSON Parser
+FF6 BCEX Spoiler Log to JSON Parser
+
+## Usage
+
+`./main.py <spoiler log filename.txt>`
+
+It's recommended to pipe the output to `jq` or a similar json parsing tool.
+
+## Why?
+
+The FF6 BCEX spoiler log format is extremely inconsistent and clearly designed purely for human consumption. Doing anything automated with it is difficult at best. This utility attempts to provide the middleware to turn the spoiler log into a data structure (in this case json) that can be parsed by another tool for any number of purposes.
+
+Its original purpose was to allow the automation of validating the difficulty of a seed by checking that a seed contains specific tools needed at specific checkpoints in the game (for example: that the forced party for the Lethe River segment is capable of defending Banon).
+
+Other uses can include presenting randomization data in a way it can be studied to create trackers and solvers, using the JSON data as a lens to create a differently formatted spoiler log with data redacted or altered, or creating a web front end that displays the spoiler data in a more friendly manner.
+
+## Limitations
+
+The parser is quite brittle since the inconsistency of the original spoiler log format requires it to make assumptions about data structures. It is likely future versions of BCEX will break it.
+
+Additionally the tool only parses spoiler log data needed for known use-cases, so if you plan to use it you may need to request the inclusion of spoiler log sections. The tool can be expanded by adding new functions named `parse_SECTION` where `SECTION` is the full name of a section in the log, as presented in the log.

main.py

@@ -1,5 +1,8 @@
 #!/usr/bin/env python3
 
+__version__ = '0.1'
+__author__ = 'Trysdyn Black'
+
 import json
 import sys