via

commit

ae7ef8e10dd25f1e6cf371065e7990a70e988127

parent

2412152cb1d4407451eeea34a1b941908db07ff5

Author

Tobias Bengfort <tobias.bengfort@posteo.de>

Date

2020-04-04 06:44

add README

Diffstat

2 files changed, 39 insertions, 0 deletions

diff --git a/Makefile b/Makefile

@@ -6,3 +6,4 @@ install:
    6     6 	install -D -m 755 via "${DESTDIR}/usr/bin/via"
    7     7 	install -D -m 644 via.service "${DESTDIR}/lib/systemd/system/via.service"
    8     8 	install -D -m 644 via.nginx "${DESTDIR}/etc/nginx/sites-available/via"
   -1     9 	install -D -m 644 README.md "${DESTDIR}/usr/share/doc/via/README.md"

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

@@ -0,0 +1,38 @@
   -1     1 # Via - Simple pubsub server
   -1     2 
   -1     3 This is very much inspired by <https://patchbay.pub/> and its clones
   -1     4 [conduit](https://github.com/prologic/conduit) and
   -1     5 [duct](https://github.com/schollz/duct).
   -1     6 
   -1     7 
   -1     8 ## Usage
   -1     9 
   -1    10 Start the server:
   -1    11 
   -1    12 	via [-v] [[host]:port]
   -1    13 
   -1    14 Then start sending requests on the client:
   -1    15 
   -1    16 	# initiate GET and wait for data
   -1    17 	curl http://localhost:8001/someid
   -1    18 
   -1    19 	# start listening for server sent event stream
   -1    20 	curl http://localhost:8001/someid?sse
   -1    21 
   -1    22 	# POST some data
   -1    23 	curl http://localhost:8001/someid -d somedata
   -1    24 
   -1    25 You can also protect your ID with a password so no one else can listen to
   -1    26 it at the same time:
   -1    27 
   -1    28 	curl http://localhost:8001/someid:somepassword
   -1    29 	curl http://localhost:8001/someid  # 403
   -1    30 	curl http://localhost:8001/someid -d somedata  # 200
   -1    31 
   -1    32 
   -1    33 ## Differences to patchbay
   -1    34 
   -1    35 -	no support for MPMC (blocking POST)
   -1    36 -	no support for req/res
   -1    37 -	support for [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events)
   -1    38 -	support for passwords