|
3 | 3 | ## Simple WebSocket Client/Server for PHP |
4 | 4 | ### Formerly known as php-websocket |
5 | 5 |
|
6 | | -[](http://travis-ci.org/varspool/Wrench) |
7 | | - |
8 | | -Version: **2.0.0-beta** |
| 6 | +* Version: **2.0.0-beta** |
| 7 | +* Build Status: [](http://travis-ci.org/varspool/Wrench) |
| 8 | +* Documentation: [wrench.readthedocs.org](http://wrench.readthedocs.org/en/latest/index.html) |
9 | 9 |
|
10 | 10 | A simple websocket server and client package for PHP 5.3/5.4, using |
11 | | -streams. |
12 | | - |
13 | | -### Features |
14 | | - |
15 | | -- Supports websocket draft hybi-10,13 (Currently tested with Chrome 20 and |
16 | | - Firefox 14). |
17 | | -- Supports origin-check. |
18 | | -- Supports various security/performance settings. |
19 | | -- Supports binary frames. (Currently receive only) |
20 | | -- Supports wss. (Needs valid certificate in Firefox.) |
| 11 | +streams. Protocol support is based around [RFC 6455](http://tools.ietf.org/html/rfc6455), |
| 12 | +targeting the latest stable versions of Chrome and Firefox. |
| 13 | +(Suggest other clients [here](https://github.com/varspool/Wrench/wiki)) |
21 | 14 |
|
22 | 15 | ### Backward compatibility |
23 | 16 |
|
24 | | -#### Why the name change? |
25 | | - |
26 | | -See [Frequently Asked Questions about the PHP License](http://php.net/license/index.php#fac-lic). |
27 | | -Also, the namespace WebSocket is too generic; it denotes a common functionality, |
28 | | -and may already be in use by application code. The BC break of a new |
29 | | -[major version](http://semver.org/) was a good time to introduce this move |
30 | | -to best practices. |
31 | | - |
32 | 17 | #### Public API |
33 | 18 |
|
34 | 19 | The new vendor namespace is Wrench. This namespace begins in the `/lib` |
35 | 20 | directory, rather than `server/lib`. |
36 | 21 |
|
37 | 22 | Apart from the new namespace, the public API of this new major version is |
38 | | -almost completely compatible with that of php-websocket 1.0.0. |
| 23 | +fairly compatible with that of php-websocket 1.0.0. |
39 | 24 |
|
40 | 25 | #### Protected API |
41 | 26 |
|
|
0 commit comments