Merge pull request #7 from ZPascal/update-the-documentation

Update the documentation

Author: ZPascal

README.md

@@ -1,5 +1,14 @@
 # Grafana API SDK ![Coverage report](https://github.com/ZPascal/grafana_api_sdk/blob/main/docs/coverage.svg)
-The repository includes an SDK for the Grafana API. It's possible to communicate with the Grafana API endpoints. Another feature of the SDK is the possibility to specify the used folder for the dashboard.
+The repository includes a Python SDK for the Grafana API. It's possible to communicate with the Grafana API endpoints. Another feature of the SDK is the possibility to specify the used folder for the dashboard.
+
+## Differences between [grafana-client](https://github.com/panodata/grafana-client), [grafana_api](https://github.com/m0nhawk/grafana_api/) and the [grafana_api_sdk](https://github.com/ZPascal/grafana_api_sdk)
+The grafana-client is only a fork of the non-maintained grafana_api repository. In general, the grafana-client project started at the same time, as I started this project. The corresponding SDK is a completely new project and based on non-other project and include a few features that are currently not implemented inside the grafana-client.
+
+The main feature that is implemented inside this library:
+
+- Grafana V8 Alerting API support (possibility to communicate (currently read only) with the attached Prometheus and Alertmanager)
+
+In general my focus inside this project is to implement and deliver old and new features from the Grafana API, to document all features and functionality clear and to increase the overall test coverage of the project.
 
 ## Currently, supported features
 

setup.py

@@ -16,7 +16,9 @@
     long_description_content_type="text/markdown",
     url="https://github.com/ZPascal/grafana_api_sdk",
     project_urls={
+        "Source": "https://github.com/ZPascal/grafana_api_sdk",
         "Bug Tracker": "https://github.com/ZPascal/grafana_api_sdk/issues",
+        "Documentation": "https://zpascal.github.io/grafana_api_sdk/",
     },
     classifiers=[
         "Programming Language :: Python :: 3",