Skip to content

Commit 2095fd4

Browse files
authored
readme nits, remove mailing list
1 parent fb268d9 commit 2095fd4

File tree

1 file changed

+11
-20
lines changed

1 file changed

+11
-20
lines changed

README.md

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
Zurl
2-
====
3-
Author: Justin Karneges <[email protected]>
4-
Mailing List: http://lists.fanout.io/mailman/listinfo/fanout-users
1+
# Zurl
52

6-
Description
7-
-----------
3+
Author: Justin Karneges <[email protected]>
4+
5+
## Description
86

97
Zurl is an HTTP and WebSocket client daemon with a ZeroMQ interface. Send it a message to make an HTTP request.
108

@@ -35,13 +33,11 @@ Zurl can also make sense as part of a greater ZeroMQ-based architecture, where y
3533

3634
See [Fun With Zurl](http://blog.fanout.io/2014/02/18/fun-with-zurl-the-http-websocket-client-daemon/) for some wild possibilities that a message-oriented HTTP client daemon can bring.
3735

38-
License
39-
-------
36+
## License
4037

4138
Zurl is offered under the GNU GPL. See the COPYING file.
4239

43-
Features
44-
--------
40+
## Features
4541

4642
* Request HTTP and HTTPS URLs
4743
* Connect to WS and WSS URLs for WebSockets
@@ -52,15 +48,13 @@ Features
5248
* Packet format can be JSON or TNetStrings
5349
* Set access policies (e.g. block requests to 10.*)
5450

55-
Requirements
56-
------------
51+
## Requirements
5752

5853
* qt >= 5.2
5954
* libzmq >= 2.0
6055
* libcurl >= 7.20
6156

62-
Setup
63-
-----
57+
## Setup
6458

6559
If accessing from Git, be sure to pull submodules:
6660

@@ -77,8 +71,7 @@ Run:
7771
cp zurl.conf.example zurl.conf
7872
./zurl --verbose --config=zurl.conf
7973

80-
Message Format
81-
--------------
74+
## Message Format
8275

8376
Requests and response messages are encoded in JSON or TNetStrings format. The format type is indicated by prefixing the encoded output with either a 'J' character or a 'T' character, respectively.
8477

@@ -134,14 +127,12 @@ Responses may have the following fields:
134127
* ``body`` - The response body content.
135128
* ``user-data`` - If this field was specified in the request, then it will be included in the response.
136129

137-
Sockets
138-
-------
130+
## Sockets
139131

140132
For basic usage, connect to Zurl's request-based interface using a REQ socket (ipc:///tmp/zurl-req by default, see your zurl.conf). To make a request, send a message over the socket. To receive the response, read from the socket.
141133

142134
For advanced usage you can connect to Zurl's streaming interface using PUSH, ROUTER, and SUB sockets. See tools/getstream.py as an example or check out the [ZHTTP draft spec](http://rfc.zeromq.org/spec:33) for details.
143135

144-
WebSockets
145-
----------
136+
## WebSockets
146137

147138
Creating a WebSocket connection through Zurl uses a variant of the ZHTTP protocol. Zurl's streaming interface must be used in this case. The protocol is not documented yet, but you can see tools/wsecho.py as an example.

0 commit comments

Comments
 (0)