Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Update README

  • Loading branch information...
commit 12daa770202e74d84af33a2580a35d2d845386e0 1 parent 99f7e79
Ben LeMasurier authored October 20, 2011

Showing 1 changed file with 27 additions and 0 deletions. Show diff stats Hide diff stats

  1. 27  README
27  README
... ...
@@ -1,5 +1,32 @@
1 1
 Blode is a simple yet powerful syslog-like event server written in node.js
2 2
 
  3
+Basically, it works like this:
  4
+
  5
+      +--------+  +--------+  +--------+
  6
+      |  php   |  |  ruby  |  | syslog |    <-- event sources
  7
+      +--------+  +--------+  +--------+
  8
+           \           |          /
  9
+            \          |         /        
  10
+             \         |        /        
  11
+              \        |       /         
  12
+            +--------------------+          
  13
+            |    blode server    |          <-- event listener/broadcaster
  14
+            +--------------------+
  15
+                       |
  16
+                      / \
  17
+                     /   \
  18
+                    /     \
  19
+                   /       \
  20
+                  /         \
  21
+          +---------+     +----------+
  22
+          | browser |     | database |       <-- event stream clients
  23
+          +---------+     +----------+
  24
+       
  25
+
  26
+Events are pushed from any source via tcp/udp/http to the blode listener. Any event
  27
+received by blode is then pushed out to any listening clients. Clients can obverve
  28
+the broadcast via a websocket, tcp, or udp connection.
  29
+
3 30
 Requirements: node.js >= 0.4.12 
4 31
               npm (npmjs.org :: `curl http://npmjs.org/install.sh | sudo sh`)
5 32
 

0 notes on commit 12daa77

Please sign in to comment.
Something went wrong with that request. Please try again.