modify readme + setup.py to render on pypi

README.md

@@ -34,6 +34,8 @@ via:
 ```
 pip install -e .
 ```
+
 ## Contributing
+
 Contributions through issues, feature requests, and pull requests are welcome.
 Guidelines are provided [here](CONTRIBUTING.md).

setup.py

@@ -7,11 +7,17 @@
 with open(version_file, "r") as fr:
     version = fr.read().strip()
 
+readme_file = os.path.join(os.path.dirname(__file__), "README.md")
+with open(readme_file, "r") as fr:
+    long_description = fr.read().strip()
+
 
 setup(
     name="autocat",
     version=version,
     description="Tools for automated generation of catalyst structures and sequential learning",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
     url="https://github.com/aced-differentiate/auto_cat",
     author="Lance Kavalsky",
     author_email="[email protected]",
@@ -22,6 +28,6 @@
     ],
     package_dir={"": "src"},
     packages=find_packages(where="src"),
-    install_requires=["numpy", "ase", "pymatgen", "fire",],
+    install_requires=["numpy", "ase", "pymatgen", "fire"],
     include_package_data=True,
 )