From df181bb0f0c71d5230d81c394e3d9037e274ea3b Mon Sep 17 00:00:00 2001 From: Evgeny Poberezkin <2769109+epoberezkin@users.noreply.github.com> Date: Mon, 28 Dec 2020 16:28:57 +0000 Subject: [PATCH 1/4] docs: add correlation IDs to examples --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index ef15a71f2f..09ed01cd77 100644 --- a/README.md +++ b/README.md @@ -33,9 +33,11 @@ Comments are prefixed with `--`, they are not part of transmissions. ```telnet > +> abcd -- correlation ID, any string > > NEW 1234 -- 1234 is recipient's key +abcd IDS QuCLU4YxgS7wcPFA YB4CCATREHkaQcEh -- recipient and sender IDs for the queue ``` @@ -44,9 +46,11 @@ IDS QuCLU4YxgS7wcPFA YB4CCATREHkaQcEh -- recipient and sender IDs for the queue ```telnet > -- no signature (just press enter) +> bcda -- correlation ID, any string > YB4CCATREHkaQcEh -- sender ID for the queue > SEND :key abcd +bcda YB4CCATREHkaQcEh OK ``` @@ -55,9 +59,11 @@ OK ```telnet > 1234 -- recipient's "signature" - same as "key" in the demo +> cdab > QuCLU4YxgS7wcPFA -- recipient ID > KEY abcd -- "key" provided by sender +cdab QuCLU4YxgS7wcPFA OK ``` @@ -66,9 +72,11 @@ OK ```telnet > abcd -- sender's "signature" - same as "key" in the demo +> dabc -- correlation ID > YB4CCATREHkaQcEh -- sender ID > SEND :hello +dabc YB4CCATREHkaQcEh OK ``` @@ -77,13 +85,16 @@ OK ```telnet +-- no correlation ID for messages delivered without client command QuCLU4YxgS7wcPFA MSG ECA3w3ID 2020-10-18T20:19:36.874Z 5 hello > 1234 +> abcd > QuCLU4YxgS7wcPFA > ACK +abcd QuCLU4YxgS7wcPFA OK ``` From eede6c5da904dee424046fb228ba7b8f720e301c Mon Sep 17 00:00:00 2001 From: Evgeny Poberezkin <2769109+epoberezkin@users.noreply.github.com> Date: Mon, 11 Jan 2021 19:14:54 +0000 Subject: [PATCH 2/4] readme: released version link --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 09ed01cd77..034d34c57d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # simplex-messaging +The released version is [v0.1.0.0](https://github.com/simplex-chat/simplex-messaging/tree/v0.1.0.0) + ## SMP server demo This is a demo implementation of SMP ([simplex messaging protocol](https://github.com/simplex-chat/protocol/blob/master/simplex-messaging.md)) server. From 1c2ac43a13bf41ed7810950e14826403268fb504 Mon Sep 17 00:00:00 2001 From: Evgeny Poberezkin <2769109+epoberezkin@users.noreply.github.com> Date: Mon, 11 Jan 2021 19:23:36 +0000 Subject: [PATCH 3/4] rename workflow, build/version badges --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 034d34c57d..869f44afde 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # simplex-messaging -The released version is [v0.1.0.0](https://github.com/simplex-chat/simplex-messaging/tree/v0.1.0.0) +[![GitHub build](https://github.com/simplex-chat/simplex-messaging/workflows/build/badge.svg)](https://github.com/simplex-chat/simplex-messaging/actions?query=workflow%3Abuild) +![GitHub release](https://img.shields.io/github/v/release/simplex-chat/simplex-messaging) ## SMP server demo From 062934ec1e4eb325a1a95b376e23165260ef1b51 Mon Sep 17 00:00:00 2001 From: Evgeny Poberezkin <2769109+epoberezkin@users.noreply.github.com> Date: Mon, 11 Jan 2021 19:25:37 +0000 Subject: [PATCH 4/4] readme: link to releases --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 869f44afde..eab4c1dba7 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # simplex-messaging [![GitHub build](https://github.com/simplex-chat/simplex-messaging/workflows/build/badge.svg)](https://github.com/simplex-chat/simplex-messaging/actions?query=workflow%3Abuild) -![GitHub release](https://img.shields.io/github/v/release/simplex-chat/simplex-messaging) +[![GitHub release](https://img.shields.io/github/v/release/simplex-chat/simplex-messaging)](https://github.com/simplex-chat/simplex-messaging/releases) ## SMP server demo