Plain Markdown text on Python Package Index

[shivg7706]

Python Package Index which have the brief introduction about the package showing plain Markdown text.

[gunthercox]

Looking at the file changes since the last release to the Python Package Index, it appears that there was a handful of changes to the README.

diff --git a/README.md b/README.md
index 44d0492..3ab48ec 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,8 @@ known conversations. The language independent design of ChatterBot allows it
 to be trained to speak any language.
 
 [![Package Version](https://img.shields.io/pypi/v/chatterbot.svg)](https://pypi.python.org/pypi/chatterbot/)
+[![Python 3.6](https://img.shields.io/badge/python-3.6-blue.svg)](https://www.python.org/downloads/release/python-360/)
+[![Django 2.0](https://img.shields.io/badge/Django-2.0-blue.svg)](https://docs.djangoproject.com/en/2.1/releases/2.0/)
 [![Requirements Status](https://requires.io/github/gunthercox/ChatterBot/requirements.svg?branch=master)](https://requires.io/github/gunthercox/ChatterBot/requirements/?branch=master)
 [![Build Status](https://travis-ci.org/gunthercox/ChatterBot.svg?branch=master)](https://travis-ci.org/gunthercox/ChatterBot)
 [![Documentation Status](https://readthedocs.org/projects/chatterbot/badge/?version=stable)](http://chatterbot.readthedocs.io/en/stable/?badge=stable)
@@ -38,14 +40,15 @@ pip install chatterbot
 
 from chatterbot import ChatBot
+from chatterbot.trainers import ChatterBotCorpusTrainer
 
-chatbot = ChatBot(
-    'Ron Obvious',
-    trainer='chatterbot.trainers.ChatterBotCorpusTrainer'
-)
+chatbot = ChatBot('Ron Obvious')
 
-# Train based on the english corpus
-chatbot.train("chatterbot.corpus.english")
+# Create a new trainer for the chatbot
+trainer = ChatterBotCorpusTrainer(chatbot)
+
+# Train the chatbot based on the english corpus
+trainer.train("chatterbot.corpus.english")
 
 # Get a response to an input statement
 chatbot.get_response("Hello, how are you today?")
@@ -54,21 +57,26 @@ chatbot.get_response("Hello, how are you today?")
 # Training data
 
 ChatterBot comes with a data utility module that can be used to train chat bots.
-At the moment there is three languages, English, Spanish and Portuguese training data in this module. Contributions
-of additional training data or training data in other languages would be greatly
-appreciated. Take a look at the data files in the
-[chatterbot-corpus](https://github.com/gunthercox/chatterbot-corpus)
+At the moment there is three languages, English, Spanish and Portuguese training
+data in this module. Contributions of additional training data or training data
+in other languages would be greatly appreciated. Take a look at the data files
+in the [chatterbot-corpus](https://github.com/gunthercox/chatterbot-corpus)
 package if you are interested in contributing.
 
+from chatterbot.trainers import ChatterBotCorpusTrainer
+
+# Create a new trainer for the chatbot
+trainer = ChatterBotCorpusTrainer(chatbot)
+
 # Train based on the english corpus
-chatbot.train("chatterbot.corpus.english")
+trainer.train("chatterbot.corpus.english")
 
 # Train based on english greetings corpus
-chatbot.train("chatterbot.corpus.english.greetings")
+trainer.train("chatterbot.corpus.english.greetings")
 
 # Train based on the english conversations corpus
-chatbot.train("chatterbot.corpus.english.conversations")
+trainer.train("chatterbot.corpus.english.conversations")
 
 **Corpus contributions are welcome! Please make a pull request.**

I'll take a look soon to see if I can determine exactly what change broke the display on PyPI.

[Sangarshanan]

I think using different version of twine and rebuilding with the latest version of wheel will solve this issue

check out stared/livelossplot#34

[gunthercox]

@Sangarshanan Thank you, I'll have to try that.

[vkosuri]

I think this reference https://stackoverflow.com/a/26737672/358458 might help to resolve this issue