diff --git a/README.md b/README.md index d11b8a287f52dcb69e3611f85a0428e44f008b55..537abfae36315284c80affda56b54555087613e2 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 ```