Merge pull request #128 from matt-bernhardt/updated-readme

Updates readme

README.md

@@ -12,6 +12,41 @@ Trapp provides several tools for the user to work with soccer data:
 
 Each of these will be described in more detail as the project progresses. For now, efforts are focused on the first tool, an importer capable of harvesting spreadsheet data into the appropriate database tables.
 
+## Installing
+
+My hope is that this project can be installed in a comparable way to other python libraries. When I do so myself, the steps look like this:
+
+```
+git clone [email protected]:matt-bernhardt/trapp.git
+cd trapp
+pip install -r requirements.txt
+python setup.py install
+```
+
+Following this, I establish the database credentials - which exist as four environment variables:
+
+* TRAPP_DBHOST
+* TRAPP_DBPWD
+* TRAPP_DBSCHEMA
+* TRAPP_DBUSER
+
+For confirmation that everything is ready to go, the `check-db` verb is useful. The output should look something like:
+
+```
+(myvenv) $ trapp -v check-db
+Checking database connection
+
+Credentials:
+dbuser:   username
+dbpwd:    password
+dbhost:   host
+dbschema: schema
+
+<mysql.connector.connection.MySQLConnection object at 0x7ff2988f02b0>
+MySQLCursorBuffered: (Nothing executed yet)
+Warnings: None
+```
+
 ## For more information
 
 More information about this project can be found on the [Massive Report Data blog](http://www.massivereportdata.com/blog). To contact the author, please email Matt Bernhardt at matt [at] massivereportdata [dot] com or on Twitter at [@BernhardtSoccer](https://twitter.com/bernhardtsoccer).

setup.py

@@ -13,7 +13,7 @@
 
 setup(
     name='trapp',
-    version='0.5.0-beta1',
+    version='0.5.0b2',
     description='Link, analyze, and extend soccer data',
     url='https://github.com/matt-bernhardt/trapp',
     license=license,