aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0bb4db0..efa5cfb 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,9 @@
1Diffusion 1Diffusion
2========= 2=========
3
4Diffusion is a simple websocket broadcaster written in Go.
5
6Everything sent on /b/{{channel}} is broadcast to every connection on /{{channel}}.
7
8Broadcaster and client accesses can be restricted by a key for each and they will have to connect to /b/{{channel}}?{{broadcaster key}} or /{{channel}}?{{client key}}.
9These keys are definable using command line arguments when starting the program. \ No newline at end of file