Merge pull request #16 from roycoding/0.3.1

0.3.1
Fixes #15 and sets default to `live=False`

Author: roycoding

README.md

@@ -4,6 +4,7 @@
 Slots is intended to be a basic, very easy-to-use multi-armed bandit library for Python.
 
 [![PyPI](https://img.shields.io/pypi/v/slots)](https://pypi.org/project/slots/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Downloads](https://pepy.tech/badge/slots)](https://pepy.tech/project/slots)
 
 #### Author
@@ -22,7 +23,7 @@ Using slots to determine the best of 3 variations on a live website.
 ```Python
 import slots
 
-mab = slots.MAB(3)
+mab = slots.MAB(3, live=True)
 ```
 
 Make the first choice randomly, record responses, and input reward 2 was chosen. Run online trial (input most recent result) until test criteria is met.
@@ -120,3 +121,12 @@ For documentation on the slots API, see [slots-docs.md](https://github.com/royco
 - More MAB strategies
 - Argument to save regret values after each trial in an array.
 - TESTS!
+
+### Contributing
+
+I welcome contributions, though the pace of development is highly variable. Please file issues and sumbit pull requests as makes sense.
+
+The current development environment uses:
+
+- pytest >= 5.3 (5.3.2)
+- black >= 19.1 (19.10b0)

docs/slots-docs.md

@@ -23,7 +23,7 @@ This documents details the current and planned API for slots. Non-implemented fe
 #### Running slots with a live website
 ```Python
 # Using slots to determine the best of 3 variations on a live website. 3 is the default.
-mab = slots.MAB(3)
+mab = slots.MAB(3, live=True)
 
 # Make the first choice randomly, record responses, and input reward
 # 2 was chosen.

setup.py

@@ -16,10 +16,11 @@
 setup(
     name='slots',
 
-    version='0.3.0',
+    version='0.3.1',
 
     description='A multi-armed bandit library for Python',
     long_description=long_description,
+    long_description_content_type="text/markdown",
 
     # The project's main homepage.
     url='https://github.com/roycoding/slots',