Skip to content

Commit d246067

Browse files
committed
fix: update README authentication parameters and class name
- Change DispatchApiClient to Client in Quick Start section - Update authentication from key to auth_key and sign_secret - Fix documentation URL to point to correct Client class Closes: #182
1 parent 5b74a4b commit d246067

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,15 @@ pip install -e .
4343
Get up and running in minutes with this simple example:
4444

4545
```python
46-
from frequenz.client.dispatch import DispatchApiClient
46+
from frequenz.client.dispatch import Client
4747
import asyncio
4848

4949
async def main():
5050
# Initialize the client with your API credentials
51-
client = DispatchApiClient(
52-
key="your_api_key_here",
53-
server_url="grpc://dispatch.url.goes.here.example.com"
51+
client = Client(
52+
auth_key="your_auth_key_here",
53+
sign_secret="your_sign_secret_here",
54+
server_url="grpc://fz-0004.frequenz.io"
5455
)
5556

5657
# List all dispatches for microgrid ID 1
@@ -67,7 +68,7 @@ asyncio.run(main())
6768

6869
## 🛠️ Usage
6970

70-
For detailed usage and advanced features, check out the [client documentation](https://frequenz-floss.github.io/frequenz-client-dispatch-python/latest/reference/frequenz/client/dispatch/#frequenz.client.dispatch.ApiDispatchClient).
71+
For detailed usage and advanced features, check out the [client documentation](https://frequenz-floss.github.io/frequenz-client-dispatch-python/latest/reference/frequenz/client/dispatch/#frequenz.client.dispatch.Client).
7172

7273
## 🌐 Supported Platforms
7374

0 commit comments

Comments
 (0)