Merge pull request #146 from artefactory/feature/long_description

new release with long description, documentation correction

README.md

@@ -33,13 +33,14 @@ Cannot find what you were looking for? Feel free to open an [issue]((https://git
 
 This package has been tested on Python **3.6**, **3.7** and **3.8**.
 
+We strongly advise you to do the remaining steps in a virtual environnement.
+
 To install this library you just have to run the following command:
 
 ```bash
 pip install nlpretext
 ```
 
-We strongly advise you to do the remaining steps in a virtual environnement.
 
 
 This library uses Spacy as tokenizer. Current models supported are `en_core_web_sm` and `fr_core_news_sm`. If not installed, run the following commands:

VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

docs/nlpretext.augmentation.rst

@@ -1,7 +1,7 @@
 nlpretext.augmentation module
 -----------------------------
 
-.. automodule:: nlpretext.augmentation.preprocess
+.. automodule:: nlpretext.augmentation.text_augmentation
    :members:
    :undoc-members:
    :show-inheritance:

setup.py

@@ -25,12 +25,17 @@
 with open("requirements.txt", "r") as fr:
     requirements = [req for req in fr.read().splitlines() if not req.startswith("#")]
 
+with open("README.md", "r") as fr:
+    long_description = fr.read()
+
 setuptools.setup(
     name='nlpretext',
     packages=setuptools.find_packages(),
-    scripts=["VERSION", "requirements.txt"],
+    scripts=["VERSION", "requirements.txt", "README.md"],
     version=version,
     description='All the goto functions you need to handle NLP use-cases',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
     author='Artefact',
     license='MIT',
     url='https://github.com/artefactory/NLPretext',