Skip to content

Commit 64362fe

Browse files
committed
update readme
1 parent 6005bdc commit 64362fe

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
This is a demo implementation of SMP ([simplex messaging protocol](https://github.com/simplex-chat/protocol/blob/master/simplex-messaging.md)) server.
66

7-
This is not usable for real applications, as it lacks the following protocol features:
7+
It has a very limited utility (if any) for real applications, as it lacks the following protocol features:
88

99
- cryptographic signature verification, instead it simply compares provided "signature" with stored "public key", effectively treating them as plain text passwords.
1010
- there is no transport encryption
1111

12-
These limitations make it easy to experiment with the protocol logic via telnet.
12+
Because of these limitations, it is easy to experiment with the protocol logic via telnet.
1313

1414
You can either run it locally or try with the deployed demo server:
1515

@@ -25,22 +25,22 @@ telnet smp.simplex.im 5223
2525

2626
Lines you should send are prefixed with `>` character, you should not type them.
2727

28-
Comments are prefixed with `--`, they are not part of transmission.
28+
Comments are prefixed with `--`, they are not part of transmissions.
2929

30-
`>` on its own means you need to press return - telnet should be configured to send CRLF.
30+
`>` on its own means you need to press `return` - telnet should be configured to send it as CRLF.
3131

3232
1. Create simplex message queue:
3333

3434
```telnet
3535
>
3636
>
37-
> CONN 1234 -- 1234 is recipient's key
37+
> NEW 1234 -- 1234 is recipient's key
3838
3939
40-
IDS QuCLU4YxgS7wcPFA YB4CCATREHkaQcEh -- recipient and sender ID for the queue
40+
IDS QuCLU4YxgS7wcPFA YB4CCATREHkaQcEh -- recipient and sender IDs for the queue
4141
```
4242

43-
2. Sender can send their "key" to the connection:
43+
2. Sender can send their "key" to the queue:
4444

4545
```telnet
4646
> -- no signature (just press enter)

0 commit comments

Comments
 (0)