Skip to content

Commit 37151ce

Browse files
committed
Point to RtD
1 parent 24063e7 commit 37151ce

File tree

1 file changed

+7
-22
lines changed

1 file changed

+7
-22
lines changed

README.md

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,39 +3,24 @@
33
## Simple WebSocket Client/Server for PHP
44
### Formerly known as php-websocket
55

6-
[![Build Status](https://secure.travis-ci.org/varspool/Wrench.png?branch=master)](http://travis-ci.org/varspool/Wrench)
7-
8-
Version: **2.0.0-beta**
6+
* Version: **2.0.0-beta**
7+
* Build Status: [![Build Status](https://secure.travis-ci.org/varspool/Wrench.png?branch=master)](http://travis-ci.org/varspool/Wrench)
8+
* Documentation: [wrench.readthedocs.org](http://wrench.readthedocs.org/en/latest/index.html)
99

1010
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))
2114

2215
### Backward compatibility
2316

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-
3217
#### Public API
3318

3419
The new vendor namespace is Wrench. This namespace begins in the `/lib`
3520
directory, rather than `server/lib`.
3621

3722
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.
3924

4025
#### Protected API
4126

0 commit comments

Comments
 (0)