From e2ab5aa69bfd81962a9d1e4ac7f3ea4bf76d924a Mon Sep 17 00:00:00 2001
From: Weiwei Chen <wchen@mpifr-bonn.mpg.de>
Date: Tue, 21 Mar 2023 15:17:15 +0100
Subject: [PATCH] [mod]: update the README.md file.
---
README.md | 18 +++++++++++-------
1 file changed, 11 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index d11b8a2..537abfa 100644
--- a/README.md
+++ b/README.md
@@ -14,19 +14,23 @@ There is a full example in `test/main_test.py`.
Create a config dictionary.
```
-client_cofnig = {'host_url': 'http://127.0.0.1',
- 'api_route': 'api',
- 'port': 5000,
- 'api_version': '1.0.1',
- 'session_id': 0}
+receiver_client_cofnig = {
+ 'host_url': 'http://127.0.0.1',
+ 'api_route': 'api',
+ 'port': 5000,
+ 'api_version': '1.0.1',
+ 'session_id': 0,
+ 'client_type': 'receiver',
+ 'client_id': '[rx_uuid]'
+}
```
Instantiate a client API object.
```
-receiver_config = MoonbounceClientAPI(client_cofnig)
+receiver_api_client = MoonbounceClientAPI(receiver_client_cofnig)
```
Instantiate a client with the API object.
```
-receiver = MoonbounceReceiver(receiver_config)
+receiver = MoonbounceReceiver(receiver_api_client)
```
Start the client
```
--
GitLab