diff --git a/CHANGELOG.md b/CHANGELOG.md index 0fda3c2..dbc440c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +# simple-message-channel 0.0.1a2 (2020-08-05) + +- Fix up documentation example + # simple-message-channel 0.0.1a1 (2020-08-05) - The first alpha development release is made! diff --git a/README.md b/README.md index 3c96abe..b9da5fc 100644 --- a/README.md +++ b/README.md @@ -15,22 +15,20 @@ $ pip install simple-message-channels ```python from simple_message_channels import SimpleMessageChannel -smc_a = SimpleMessageChannel() -smc_b = SimpleMessageChannel() +smc1 = SimpleMessageChannel() +smc2 = SimpleMessageChannel() -payload = smc_b.send(0, 1, b"foo") +payload = smc1.send(0, 1, b"foo") print(f"sent: {payload}") for idx in range(0, len(payload)): - smc_a.recv(payload[idx : idx + 1]) - -for msg in smc_a.messages: - print(f"received: {msg}") + smc2.recv(payload[idx : idx + 1]) +print(f"received: {smc2.messages}") ``` Output: ```sh sent: b'\x04\x01foo' -received: (0, 1, b'foo') +received: [(0, 1, b'foo')] ``` diff --git a/pyproject.toml b/pyproject.toml index b7f25c4..de4a9d9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "poetry.masonry.api" [tool.poetry] name = "simple-message-channels" -version = "0.0.1a1" +version = "0.0.1a2" description = "Sans I/O wire protocol for Hypercore" authors = ["decentral1se "] maintainers = ["decentral1se "]