add README as package description

jelleschutter · Apr 20, 2021 · e4a94b6 · e4a94b6
1 parent 1d2eec9
commit e4a94b6
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/setup.py b/setup.py
@@ -44,6 +44,9 @@ def run(self):
     root_files = [os.path.join(root, i) for i in files]
     data_files.append((root, root_files))
 
+with open('README.md', 'r') as readme:
+    long_description = readme.read()
+
 setup_args = {
     'name': 'nbconvert-theme-pale-sand-navy',
     'version': '0.2.0',
@@ -53,6 +56,8 @@ def run(self):
     ],
     'author': 'Jelle Schutter',
     'author_email': '[email protected]',
+    'long_description': long_description,
+    'long_description_content_type': 'text/markdown',
     'url': 'https://github.com/jelleschutter/nbconvert-theme-pale-sand-navy',
     'cmdclass': {
         'develop': DevelopCmd,