via

commit

e35e2b5f0e8572b5fd4856d92e9c50848f0b7fb1

parent

b4a21a15d3c9c3d7c5fd98a8e8802c0d900211b7

Author

Tobias Bengfort <tobias.bengfort@posteo.de>

Date

2020-10-15 08:59

adapt README to hmsg

Diffstat

1 files changed, 13 insertions, 0 deletions

diff --git a/README.md b/README.md

@@ -18,6 +18,18 @@ Then start sending requests on the client:
   18    18 	# POST a message
   19    19 	curl http://localhost:8001/msg/someid -d somedata
   20    20 
   -1    21 Use the `hmsg` prefix if you want to keep a history:
   -1    22 
   -1    23 	# start listening and request any messages you may have missed
   -1    24 	curl http://localhost:8001/hmsg/someid -H 'Last-Event-Id: 3'
   -1    25 
   -1    26 	# POST works just as before
   -1    27 	curl http://localhost:8001/hmsg/someid -d somedata
   -1    28 
   -1    29 	# the history only keeps up to 100 entries.
   -1    30 	# you can optimize it by replacing all entries by a single message
   -1    31 	curl http://localhost:8001/hmsg/someid -d combined -H 'Last-Event-Id: 3' -X PUT
   -1    32 
   21    33 You can also protect your ID with a password so no one else can listen to
   22    34 it at the same time:
   23    35 
@@ -36,3 +48,4 @@ You should regularly clean up old files:
   36    48 -	no support for blocking GET
   37    49 -	support for [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events)
   38    50 -	support for passwords
   -1    51 -	support for message history