Merge pull request #158 from camunda-community-hub/development

Add badges/docs cleanup

README.md

@@ -1,26 +1,29 @@
+[![](https://img.shields.io/badge/Community%20Extension-An%20open%20source%20community%20maintained%20project-FF4700)](https://github.com/camunda-community-hub/community)
+[![](https://img.shields.io/badge/Lifecycle-Stable-brightgreen)](https://github.com/Camunda-Community-Hub/community/blob/main/extension-lifecycle.md#stable-)
+
 [![Coverage Status](https://coveralls.io/repos/github/JonatanMartens/pyzeebe/badge.svg?branch=master)](https://coveralls.io/github/JonatanMartens/pyzeebe?branch=master)
-![Test pyzeebe](https://github.com/JonatanMartens/pyzeebe/workflows/Test%20pyzeebe/badge.svg)
-![Integration test pyzeebe](https://github.com/JonatanMartens/pyzeebe/workflows/Integration%20test%20pyzeebe/badge.svg)
-![GitHub issues](https://img.shields.io/github/issues-raw/JonatanMartens/pyzeebe)
-![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/JonatanMartens/pyzeebe)
-![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed-raw/JonatanMartens/pyzeebe)
-![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/JonatanMartens/pyzeebe)
-![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyzeebe)
-![PyPI](https://img.shields.io/pypi/v/pyzeebe)
+![Test pyzeebe](https://github.com/camunda-community-hub/pyzeebe/workflows/Test%20pyzeebe/badge.svg)
+![Integration test pyzeebe](https://github.com/camunda-community-hub/pyzeebe/workflows/Integration%20test%20pyzeebe/badge.svg)
 
+![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/camunda-community-hub/pyzeebe)
+![PyPI](https://img.shields.io/pypi/v/pyzeebe)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyzeebe)
 
+[![Documentation Status](https://readthedocs.org/projects/pyzeebe/badge/?version=latest)](https://pyzeebe.readthedocs.io/en/latest/?badge=stable)
 
 # Pyzeebe
+
 pyzeebe is a python grpc client for Zeebe.
 
 Zeebe version support:
 
-| Pyzeebe version | Tested Zeebe versions |
-|:---------------:|----------------|
-| 2.x.x           | 0.23, 0.24, 0.25, 0.26        |
-| 1.x.x           | 0.23, 0.24         |
+| Pyzeebe version | Tested Zeebe versions  |
+| :-------------: | ---------------------- |
+|      2.x.x      | 0.23, 0.24, 0.25, 0.26 |
+|      1.x.x      | 0.23, 0.24             |
 
 ## Getting Started
+
 To install:
 
 `pip install pyzeebe`
@@ -40,7 +43,7 @@ from pyzeebe import ZeebeWorker, Job
 def on_error(exception: Exception, job: Job):
     """
     on_error will be called when the task fails
-    """ 
+    """
     print(exception)
     job.set_error_status(f"Failed to handle job {job}. Error: {str(exception)}")
 
@@ -57,9 +60,10 @@ worker.work() # Now every time that a task with type example is called example_t
 ```
 
 Stop a worker:
+
 ```python
 zeebe_worker.work() # Worker will begin working
-zeebe_worker.stop() # Stops worker after all running jobs have been completed 
+zeebe_worker.stop() # Stops worker after all running jobs have been completed
 ```
 
 ### Client
@@ -89,18 +93,21 @@ zeebe_client.publish_message(name="message_name", correlation_key="some_id")
 ```
 
 ## Tests
+
 Use the package manager [pip](https://pip.pypa.io/en/stable/) to install pyzeebe
- 
+
 `pytest tests/unit`
 
 ## Contributing
+
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 
 Please make sure to update tests as appropriate.
 
-
 ## Versioning
+
 We use [SemVer](semver.org) for versioning. For the versions available, see the tags on this repository.
 
 ## License
-We use the MIT license, see [LICENSE.md](LICENSE.md) for details
+
+We use the MIT license, see [LICENSE.md](LICENSE.md) for details