pypi-friendly README.md

README.md

@@ -38,6 +38,8 @@ Or you can cd into the site-packages subfolder of your python distribution (or e
 
 For a quick start, please go to the [Demo notebook](https://github.com/milcent/benford_py/blob/master/Demo.ipynb), in which I show examples on how to run the tests with the SPY (S&P 500 ETF) daily returns.
 
+For more fine-grained details of the functions and classes, see the [docs](https://benford-py.readthedocs.io/en/latest/index.html).
+
 ### Background
 
 The first digit of a number is its leftmost digit.

__init__.py

@@ -1,2 +1,2 @@
 '''Benfords law module'''
-__version__ = "0.3.0"
+__version__ = "0.3.1"

docs/source/conf.py

@@ -22,7 +22,7 @@
 author = 'Marcel Milcent'
 
 # The full version, including alpha/beta/rc tags
-release = '0.3.0'
+release = '0.3.1'
 
 
 # -- General configuration ---------------------------------------------------

setup.py

@@ -1,11 +1,18 @@
 ''' Setup Pyt for benford's module'''
 from setuptools import setup
 
+from os import path
+this_directory = path.abspath(path.dirname(__file__))
+with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f:
+    long_description = f.read()
+
 setup(name='benford_py',
-      version='0.3.0',
+      version='0.3.1',
       description='A library for testing data sets with Bendford\'s Law',
+      long_description=long_description,
+      long_description_content_type='text/markdown'.
       url='https://github.com/milcent/benford_py',
-      download_url='https://github.com/milcent/benford_py/archive/v0.3.0.tar.gz',
+      download_url='https://github.com/milcent/benford_py/archive/v0.3.1.tar.gz',
       author='Marcel Milcent',
       author_email='marcelmilcent@gmail.com',
       license='GPLv3.0',