Merge pull request #2 from devrimcavusoglu/doc-revision

Doc refactoring.

Author: devrimcavusoglu

README.md

@@ -1,6 +1,13 @@
-# PyBboxes
-
-Python Toolkit for Bounding Boxes providing conversion between bounding box types. Supported bounding box types:
+<h1 align="center">PyBboxes</h1>
+<p align="center">
+<a href="https://pypi.org/project/pybboxes"><img src="https://img.shields.io/pypi/v/pybboxes" alt="Python versions"></a>
+<br>
+<a href="https://pypi.org/project/pybboxes"><img src="https://img.shields.io/pypi/pyversions/pybboxes" alt="Python versions"></a>
+<a href="https://github.com/devrimcavusoglu/pybboxes/actions/workflows/ci.yml"><img src="https://img.shields.io/github/workflow/status/devrimcavusoglu/pybboxes/Tests" alt="DOI"></a>
+<a href="https://github.com/devrimcavusoglu/pybboxes/blob/main/LICENSE"><img src="https://img.shields.io/github/license/devrimcavusoglu/pybboxes" alt="Python versions"></a>
+</p>
+
+Light weight toolkit for bounding boxes providing conversion between bounding box types and simple computations. Supported bounding box types:
 
 - **albumentations** : [Albumentations Format](https://albumentations.ai/docs/getting_started/bounding_boxes_augmentation/#albumentations)
 - **coco** : [COCO (Common Objects in Context)](http://cocodataset.org/)

pybboxes/__init__.py

@@ -1,4 +1,4 @@
 from pybboxes.area import *
 from pybboxes.convert import convert_bbox
 
-__version__ = "0.0.1"
+__version__ = "0.0.2"

setup.py

@@ -44,7 +44,7 @@ def get_version():
     version=get_version(),
     author="Devrim Cavusoglu",
     license="MIT",
-    description="Evaluation toolkit for neural language generation.",
+    description="Light Weight Toolkit for Bounding Boxes",
     long_description=get_long_description(),
     long_description_content_type="text/markdown",
     url="https://github.com/devrimcavusoglu/pybboxes",