Permalink
Browse files

Add dispatch options documentation to the README

  • Loading branch information...
1 parent a76c29a commit 64fcd99b93dcd911d26656ee4bc5359b80b7e955 Loïc Hoguin committed Jan 9, 2012
Showing with 18 additions and 0 deletions.
  1. +18 −0 README.md
View
@@ -15,6 +15,24 @@ provides an optional heartbeat which is managed on the client side.
Today Bullet only supports websocket and long-polling transports.
+Dispatch options
+----------------
+
+Similar to any other handler, you need to setup the dispatch list before
+you can access your Bullet handlers. Bullet itself is a Cowboy HTTP
+handler that translates some of the lower-level functions into a
+simplified higher-level interface.
+
+The dispatch options for a Bullet handler looks as follow:
+
+``` erlang
+{[<<"path">>, <<"to">>, <<"bullet">>], bullet_handler,
+ [{handler, my_stream}]}
+```
+
+Simply define this in your dispatch list and your handler will be
+available and handled by Bullet properly.
+
Cowboy handler
--------------

0 comments on commit 64fcd99

Please sign in to comment.