Add more descriptions

README.md

@@ -2,14 +2,19 @@
 
 [![tests](https://github.com/j3soon/tbparse/actions/workflows/test-with-tox.yaml/badge.svg?branch=master&event=push)](https://github.com/j3soon/tbparse/actions/workflows/test-with-tox.yaml)
 [![build](https://github.com/j3soon/tbparse/actions/workflows/publish-to-pypi.yaml/badge.svg)](https://github.com/j3soon/tbparse/actions/workflows/publish-to-pypi.yaml)
+[![doc](https://readthedocs.org/projects/tbparse/badge/?version=latest)](https://tbparse.readthedocs.io/en/latest/?badge=latest)
+[![pypi](https://img.shields.io/pypi/v/tbparse)](https://pypi.org/project/tbparse/)
+[![python](https://img.shields.io/pypi/pyversions/tbparse)](https://pypi.org/project/tbparse/)
 
 Read, parse, and plot tensorboard event logs with ease!
 
 tbparse is a simple parser for reading tensorboard logs. It supports logs generated by [TensorFlow / Keras](https://www.tensorflow.org/tensorboard), [PyTorch](https://pytorch.org/docs/stable/tensorboard.html), and [TensorboardX](https://github.com/lanpa/tensorboardX).
 
 Currently, tbparse enables parsing native types (scalars, tensors, histograms, etc.) easily. More event types will be supported in future versions.
 
-![preview](docs/images/preview.png)
+See [the Documentation](https://tbparse.readthedocs.io) for usage details and API reference.
+
+![](docs/images/preview.png)
 
 ## Installation
 

docs/pages/changelog.rst

@@ -7,7 +7,7 @@ v0.0.2
 
 Fixes:
 
-* Fix PyPI release issue
+* Fix PyPI packaging issue
 
 v0.0.1
 ===================================

setup.py

@@ -3,20 +3,31 @@
 with open("README.md", "r", encoding="utf-8") as fh:
     long_description = fh.read()
 
+github_url = "https://github.com/j3soon/tbparse"
+
 setuptools.setup(
     name="tbparse",
     version="0.0.2",
     author="Johnson",
     author_email="j3.soon@msa.hinet.net",
-    description="A simple parser for reading tensorboard logs",
+    description="Read, parse, and plot tensorboard event logs with ease!",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    url="https://github.com/j3soon/tbparse",
+    url=github_url,
     project_urls={
-        "Bug Tracker": "https://github.com/j3soon/tbparse/issues",
+        'Changelog': f'{github_url}/blob/master/docs/pages/changelog.rst',
+        'Issues': f'{github_url}/issues',
+        'Source Code': github_url,
     },
+    keywords=(
+        'package, parser, plot, python, pytorch, reader, tensorboard, tensorboardx, tensorflow'
+    ),
     classifiers=[
-        "Programming Language :: Python :: 3",
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Science/Research',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
     ],