├── .gitignore
├── README.md
└── setup.py


/.gitignore:
--------------------------------------------------------------------------------
1 | dist/
2 | *.egg-info/
3 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | No docutils, pandoc, or any other tricks! Just a `README.md` and a `setup.py`.
 2 | 
 3 | See the source for this project here:
 4 | <https://github.com/di/markdown-description-example>.
 5 | 
 6 | Instructions to do this for your project are here:
 7 | <https://dustingram.com/articles/2018/03/16/markdown-descriptions-on-pypi>
 8 | 
 9 | ## What we can do:
10 | 
11 | We can do *italics* and **bold text**.
12 | 
13 | * Lists
14 | * Are
15 | * Fun
16 | * Too
17 |   * (But please use responsibly)
18 | 
19 | Code blocks:
20 | ```
21 | >>> pypi_supports_markdown
22 | True
23 | ```
24 | 
25 | And much much more!
26 | 


--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
 1 | from setuptools import setup
 2 | 
 3 | with open('README.md') as f:
 4 |     long_description = f.read()
 5 | 
 6 | setup(
 7 |     author='Dustin Ingram',
 8 |     author_email='di@di.codes',
 9 |     description='A PyPI package with a Markdown README',
10 |     long_description=long_description,
11 |     long_description_content_type='text/markdown',  # This is important!
12 |     name='markdown-description-example',
13 |     url='http://github.com/di/markdown-description-example',
14 |     version='0.0.1',
15 | )
16 | 


--------------------------------------------------------------------------------