ADCM-6071 Update poetry and pyproject file

README.md

@@ -1,2 +1,45 @@
-# adcm-aio-client
-ADCM Client
+# ADCM AIO Client
+
+Asynchronous HTTP Client for ADCM (Arenadata Cluster Manager)
+
+### Introduction
+
+Install `adcm_aio_client` using `pip`
+
+```shell
+pip install adcm_aio_client
+```
+
+`adcm_aio_client` requires Python 3.12+
+
+### QuickStarts
+
+First, start be import `ADCMSession` and `Credantinals`
+
+```python
+from adcm_aio_client import ADCMSession, Credentials
+```
+
+Now let's try to get a client and see a list of all clusters
+
+```python
+credentials = Credentials(username="admin", password="admin")
+async with ADCMSession(url="http://127.0.0.1:8000", credentials=credentials) as client:
+    print(await client.clusters.all())
+```
+
+The full list of available APIs can be found in the [Guides](#guides) section.
+
+### Guides
+
+- Examples of the available API for the `Bundle` entity can be found [here](/tests/integration/examples/test_bundle.py)
+- Examples of the available API for the `Cluster` entity can be
+  found [here](/tests/integration/examples/test_cluster.py)
+- Examples of the available API for the `Service` entity can be
+  found [here](/tests/integration/examples/test_service.py)
+- Examples of the available API for the `Hostprovider` entity can be
+  found [here](/tests/integration/examples/test_hostprovider.py)
+- Examples of the available API for the `Host` entity can be found [here](/tests/integration/examples/test_host.py)
+- Examples of the available API for the `Host Group` entity can be
+  found [here](/tests/integration/examples/test_host_groups.py)
+