Skip to content

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Tobias Oberstein committed Mar 12, 2012
1 parent f96b050 commit 714d92c
Showing 1 changed file with 34 additions and 36 deletions.
70 changes: 34 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
Autobahn WebSockets
===================

Features
--------

Autobahn WebSockets for Python provides an implementation of the WebSockets
protocol which can be used to build WebSockets clients and servers.

* supports RFC 6455 and Hybi-10+ protocol versions
* supports RPC/PubSub over WebSockets (WAMP - see below)
* usable for clients and servers
* easy to use basic API
* advanced API for frame-based/streaming processing
* very good standards conformance
* very good standards conformance (see below)
* fully asynchronous Twisted-based implementation
* supports secure WebSockets (TLS)
* Open-source (Apache 2 license)
Expand All @@ -17,26 +21,35 @@ protocol which can be used to build WebSockets clients and servers.
Browser Support
---------------

native support:
* Google Chrome 14+
* Mozilla Firefox 7+
* Microsoft Internet Explorer 10+
Native support:

* Google Chrome 14+
* Mozilla Firefox 7+
* Microsoft Internet Explorer 10+
* Safari/WebKit Nightly (as of March 2012)

Support via Adobe Flash 10+:

support via Adobe Flash 10+ (see below):
* Microsoft Internet Explorer 8, 9
* Safari 5
* Microsoft Internet Explorer 8, 9
* Google Chrome 4 - 13
* Mozilla Firefox 3 - 6
* Safari 5+

Support via Google Chrome Frame:

RPC/PubSub
----------
* Microsoft Internet Explorer 6 - 9


RPC/PubSub over WebSocket (WAMP)
--------------------------------

Autobahn WebSockets also provides an implementation of the

WebSocket Application Messaging Protocol (WAMP)
http://www.tavendo.de/autobahn/protocol.html
http://autobahn.ws/wamp

which can be used to build applications around Remote Procedure Call and
Publish & Subscribe messaging patterns.
which can be used to build applications around Remote Procedure Call
and Publish & Subscribe messaging patterns.

* provides RPC and PubSub messaging
* built on JSON and WebSockets
Expand All @@ -50,35 +63,20 @@ Testsuite

Autobahn WebSockets also includes a WebSockets test suite which can used to
test client and server implementations for protocol conformance.
The test suite includes nearly 300 test cases and has broad protocol coverage.


Using WebSocket Flash bridge
----------------------------
The Autobahn WebSockets Test Suite executes nearly 300 automated test cases
and has an extensive test coverage.

To use Autobahn with older browsers lacking WebSockets native support
(or only supporting an old protocol version), but having Adobe Flash 10+
installed, you will need to host the following 3 files from
For current test reports and a list of users (over 20 projects/companies),
please visit:

https://github.com/gimite/web-socket-js

WebSocketMain.swf
swfobject.js
web_socket.js

on your web server (serving the HTML/JS opening the WebSocket connection)
and include the following (in this order!) in the HTML head element:

<script type="text/javascript">
WEB_SOCKET_SWF_LOCATION = "/path/to/WebSocketMain.swf";
</script>

<script src="/path/to/autobahn.js"></script>
<script src="/path/to/swfobject.js"></script>
<script src="/path/to/web_socket.js"></script>
http://autobahn.ws/testsuite


Where to go
-----------

For more information, please visit: http://autobahn.ws

Get in touch on IRC #autobahn on chat.freenode.net or join the mailing
list on http://groups.google.com/group/autobahnws.

0 comments on commit 714d92c

Please sign in to comment.