From 88cbff2187f8a9772f8b74984c09f3b487bc9311 Mon Sep 17 00:00:00 2001
From: Lennart Weller <lhw@ring0.de>
Date: Sun, 9 Jun 2024 18:54:15 +0000
Subject: [PATCH] add some information in the readme

---
 README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++--
 setup.py  |  1 +
 2 files changed, 50 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index c7cf6ee..8da549b 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,52 @@
 # aiocloudweather
 
-Simple python library for parsing Wundergrund and Weathercloud update requests
+[![PyPI Release][pypi]][pypi-page]
+[![GitHub Activity][commits-shield]][commits]
+[![Project Maintenance][maintenance-shield]][maintainer]
+[![Mastodon][mastodon]][mastodon_profile]
 
-Based on aioecowitt
+
+A simple Python library for parsing Wunderground and Weathercloud update requests, based on aioecowitt for Ecowitt weather stations.
+
+## Installation
+
+You can install `aiocloudweather` from PyPI using pip:
+
+```shell
+pip install aiocloudweather
+```
+
+## Usage
+
+```python
+import asyncio
+import aiocloudweather
+
+async def dataset_handler(station: WeatherStation):
+    # Your code here
+
+
+app = CloudWeatherListener()
+app.new_dataset_cb.append(dataset_handler)
+
+await app.start()
+while True:
+    await asyncio.sleep(100000)
+
+```
+
+## Contributing
+
+Contributions are welcome! Please also check the [Cloud Weather Proxy][cloudweatherproxy] project which uses this library to enable the weather stations in HomeAssistant.
+
+
+
+[pypi]: https://img.shields.io/pypi/v/aiocloudweather
+[pypi-page]: https://pypi.org/project/aiocloudweather/
+[commits-shield]: https://img.shields.io/github/commit-activity/y/lhw/cloudweatherproxy.svg
+[commits]: https://github.com/lhw/cloudweatherproxy/commits/main
+[maintenance-shield]: https://img.shields.io/badge/maintainer-Lennart%20Weller%20%40lhw-blue.svg
+[maintainer]: https://github.com/lhw
+[mastodon]: https://img.shields.io/mastodon/follow/000048422?domain=https%3A%2F%2Fchaos.social
+[mastodon_profile]: https://chaos.social/@lhw
+[cloudweatherproxy]: https://github.com/lhw/cloudweatherproxy
\ No newline at end of file
diff --git a/setup.py b/setup.py
index 77d831c..91778ec 100644
--- a/setup.py
+++ b/setup.py
@@ -22,6 +22,7 @@
     package_data={"aiocoudweather": ["py.typed"]},
     python_requires=">=3.12",
     install_requires=["aiohttp>3", "aiodns>3"],
+    license_files=["LICENSE"],
     entry_points={
         "console_scripts": ["cloudweather-testserver = aiocloudweather.__main__:main"]
     },