Improve README.md for better project discoverability

- Add expanded introduction describing the library purpose
- Add Installation section with pip and pyproject.toml examples
- Add Quick Start section with minimal working example
- Move Supported Platforms section before Installation
- Update documentation links to use /latest/ instead of /v0.1/
- Fix long lines using reference-style links
- Update Ubuntu version to 24.04
- Update version references to v1.0.1

Fixes #166

Signed-off-by: Mathias L. Baumann <[email protected]>

Author: Marenz

README.md

@@ -6,18 +6,87 @@
 
 ## Introduction
 
-A highlevel interface for the dispatch API.
+The `frequenz-dispatch` library provides a high-level Python interface for
+interacting with the Frequenz Dispatch API. This library enables you to
+manage and monitor dispatch operations in microgrids, including lifecycle
+events and running status changes of dispatch operations.
 
-See [the documentation](https://frequenz-floss.github.io/frequenz-dispatch-python/v0.1/reference/frequenz/dispatch) for more information.
+The main entry point is the [`Dispatcher`][dispatcher-class] class, which
+provides channels for receiving dispatch lifecycle events and running status
+updates, allowing you to build reactive applications that respond to dispatch
+state changes.
 
-## Usage
+## Supported Platforms
+
+The following platforms are officially supported (tested):
+
+- **Python:** 3.11
+- **Operating System:** Ubuntu Linux 24.04
+- **Architectures:** amd64, arm64
+
+## Installation
+
+### Using pip
+
+You can install the package from PyPI:
+
+```bash
+python3 -m pip install frequenz-dispatch
+```
+
+### Using pyproject.toml
+
+Add the dependency to your `pyproject.toml` file:
+
+```toml
+[project]
+dependencies = [
+    "frequenz-dispatch >= 1.0.1, < 2",
+]
+```
+
+> [!NOTE]
+> We recommend pinning the dependency to the latest version for programs,
+> like `"frequenz-dispatch == 1.0.1"`, and specifying a version range
+> spanning one major version for libraries, like
+> `"frequenz-dispatch >= 1.0.1, < 2"`. We follow [semver](https://semver.org/).
+
+## Quick Start
+
+Here's a minimal example to get you started:
 
-The [`Dispatcher` class](https://frequenz-floss.github.io/frequenz-dispatch-python/v0.1/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher), the main entry point for the API, provides two channels:
+```python
+import asyncio
+import os
+
+from frequenz.dispatch import Dispatcher
+
+async def main() -> None:
+    url = os.getenv("DISPATCH_API_URL", "grpc://localhost:50051")
+    auth_key = os.getenv("DISPATCH_API_AUTH_KEY", "my-api-key")
+    microgrid_id = 1
+
+    async with Dispatcher(
+        microgrid_id=microgrid_id,
+        server_url=url,
+        auth_key=auth_key,
+    ) as dispatcher:
+        async for event in dispatcher.lifecycle_events:
+            print(f"Received lifecycle event: {event}")
+
+asyncio.run(main())
+```
+
+The [`Dispatcher` class][dispatcher-class] provides two channels:
 
-* [Lifecycle events](https://frequenz-floss.github.io/frequenz-dispatch-python/v0.1/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher.lifecycle_events): A channel that sends a message whenever a [Dispatch][frequenz.dispatch.Dispatch] is created, updated or deleted.
-* [Running status change](https://frequenz-floss.github.io/frequenz-dispatch-python/v0.1/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher.running_status_change): Sends a dispatch message whenever a dispatch is ready to be executed according to the schedule or the running status of the dispatch changed in a way that could potentially require the actor to start, stop or reconfigure itself.
+* [Lifecycle events][lifecycle-events]: A channel that sends a message whenever
+  a Dispatch is created, updated or deleted.
+* [Running status change][running-status-change]: Sends a dispatch message
+  whenever a dispatch is ready to be executed according to the schedule or the
+  running status of the dispatch changed in a way that could potentially
+  require the actor to start, stop or reconfigure itself.
 
-### Example using the running status change channel
+### Example managing actors with dispatch events
 
 ```python
 import os
@@ -26,21 +95,23 @@ from datetime import timedelta
 
 from frequenz.dispatch import Dispatcher, DispatchInfo, MergeByType
 
-async def create_actor(dispatch: DispatchInfo, receiver: Receiver[DispatchInfo]) -> Actor:
+async def create_actor(
+    dispatch: DispatchInfo, receiver: Receiver[DispatchInfo]
+) -> Actor:
     return MagicMock(dispatch=dispatch, receiver=receiver)
 
-async def run():
-    url = os.getenv("DISPATCH_API_URL", "grpc://dispatch.url.goes.here.example.com")
-    auth_key = os.getenv("DISPATCH_API_AUTH_KEY", "some-key")
-    sign_secret = os.getenv("DISPATCH_API_SIGN_SECRET")
+async def run() -> None:
+    url = os.getenv(
+        "DISPATCH_API_URL", "grpc://dispatch.api.example.com:50051"
+    )
+    auth_key = os.getenv("DISPATCH_API_AUTH_KEY", "my-api-key")
 
     microgrid_id = 1
 
     async with Dispatcher(
         microgrid_id=microgrid_id,
         server_url=url,
         auth_key=auth_key,
-        sign_secret=sign_secret,
     ) as dispatcher:
         await dispatcher.start_managing(
             dispatch_type="EXAMPLE_TYPE",
@@ -52,13 +123,15 @@ async def run():
         await dispatcher
 ```
 
-## Supported Platforms
+## Documentation
 
-The following platforms are officially supported (tested):
+For complete API documentation, examples, and advanced usage patterns, see
+[the documentation][docs].
 
-- **Python:** 3.11
-- **Operating System:** Ubuntu Linux 20.04
-- **Architectures:** amd64, arm64
+[dispatcher-class]: https://frequenz-floss.github.io/frequenz-dispatch-python/latest/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher
+[lifecycle-events]: https://frequenz-floss.github.io/frequenz-dispatch-python/latest/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher.lifecycle_events
+[running-status-change]: https://frequenz-floss.github.io/frequenz-dispatch-python/latest/reference/frequenz/dispatch/#frequenz.dispatch.Dispatcher.running_status_change
+[docs]: https://frequenz-floss.github.io/frequenz-dispatch-python/latest/
 
 ## Contributing