Skip to content

Commit bc5491c

Browse files
committed
Update README.md
1 parent 41049d6 commit bc5491c

File tree

1 file changed

+8
-26
lines changed

1 file changed

+8
-26
lines changed

README.md

+8-26
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,12 @@
11
PHP WebSockets
22
==============
3-
PHP WebSockets is a PHP library that implements the latest version of
4-
the WebSockets protocol. The [WebSockets protocol](http://www.rfc-editor.org/rfc/rfc6455.txt) (RFC6455) is currently being
3+
The PHP WebSockets code hasn't been updated in a while and is no longer compatible with all browsers.
4+
You probably should not use it for production code.
5+
6+
What is it?
7+
===========
8+
PHP WebSockets is a PHP library that implements the WebSockets protocol.
9+
The [WebSockets protocol](http://www.rfc-editor.org/rfc/rfc6455.txt) (RFC6455) is currently being
510
standardized by the IETF. With WebSockets, a client (e.g.: a browser) and
611
a server can set up a two-way communication channel with little overhead
7-
compared to a XMLHttpRequest or long polling.
8-
9-
Usage
10-
-----
11-
The demo can be started by starting the `Demo/run.php` file from the command-
12-
line. You might need to edit the file to change the servers IP and/or port.
13-
14-
The `ChatServer` demo is a basic chatserver that has little functionality. You
15-
can use it as a basis to build more complex `WebSocketServers` using this library.
16-
17-
The basic idea is that your `WebSocketServer` should implement the `ServerObserver`
18-
interface and subscribe to (or observe) a `WebSocketServer` instance. If you want to
19-
observer or subscribe to events that accur on the incomming `WebSocketConnections` too,
20-
you should implement the `ConnectionObserver` interface too and subscribe to the
21-
incomming connections in the `ServerObserver :: onNewConnection()` method.
22-
23-
License
24-
-------
25-
This library is licensed under the terms of the MIT license which
26-
can be found in the LICENSE file.
27-
28-
Acknowledgements
29-
----------------
30-
Thanks to Peter Beverloo for his support and advice.
12+
compared to a XMLHttpRequest or long polling.

0 commit comments

Comments
 (0)