Updated README and added CHANGELOG

Author: dominics

CHANGELOG.md

@@ -0,0 +1,9 @@
+<!-- vim: set tw=79 sw=4 ts=4 et ft=markdown : -->
+# Changelog
+## 1.0.0
+
+* Refactored methods to open up more of the protected API.
+* @lemmingzshadow switched the server to use streams instead of sockets, and
+  implemented SSL support.
+* @mazhack added support for the new WebSocket object in Firefox 11.
+* Plenty of bugfixes

README.md

@@ -1,39 +1,68 @@
-PHP WebSocket
-=============
-A websocket server implemented in php.
+<!-- vim: set tw=79 sw=4 ts=4 et ft=markdown : -->
+# PHP WebSocket
+## Simple WebSocket server for PHP
 
-- Supports websocket draft hybi-10,13 (Currently tested with Chrome 18 and Firefox 11).
+Version: **1.0.0**
+
+A simple websocket server for PHP 5.3, using streams.
+
+### Features
+
+- Supports websocket draft hybi-10,13 (Currently tested with Chrome 18 and
+  Firefox 11).
 - Supports origin-check.
 - Supports various security/performance settings.
 - Supports binary frames. (Currently receive only)
 - Supports wss. (Needs valid certificate in Firefox.)
-- Application module, the server can be extended by custom behaviors.
 
-## Bugs/Todos/Hints
-- Add support for fragmented frames.
 
-## Server example
+### Backward compatibility
+
+The public API of the server should remain compatible with early versions of
+php-websocket. The WebSocket namespace begins in the `/server/lib` directory.
+The client-side libraries are deprecated and may be removed in future: the
+exist as an example. You're free to use whatever client-side libraries you'd
+like with the server.
+
+## Installation
 
-This creates a server on localhost:8000 with one Application that listens on `ws://localhost:8000/demo`:
+The library is PSR-0 compatible, with a vendor name of WebSocket (note the
+capital S). An SplClassLoader is bundled for convenience.
 
-	$server = new \WebSocket\Server('127.0.0.1', 8000, false); // host,port,ssl
+## Usage
 
-	// server settings:	
-	$server->setCheckOrigin(true);
-	$server->setAllowedOrigin('foo.lh');
-	$server->setMaxClients(100);
-	$server->setMaxConnectionsPerIp(20);
-	$server->setMaxRequestsPerMinute(1000);
+This creates a server on 127.0.0.1:8000 with one Application that listens on
+`ws://localhost:8000/demo`:
 
-	$server->registerApplication('demo', \WebSocket\Application\DemoApplication::getInstance());
-	$server->run();
+```php
+// $interface, $port, $ssl
+$server = new \WebSocket\Server(127.0.0.1', 8000, false);
 
-## Libraries used
+// Origin checking is supported
+$server->setCheckOrigin(true);
+$server->setAllowedOrigin('example.org')
 
-- [SplClassLoader](http://gist.github.com/221634) by the PHP Standards Working Group
-- [jQuery](http://jquery.com/)
-- [CoffeeScript PHP] (https://github.com/alxlit/coffeescript-php)
+// As is basic rate limiting
+$server->setMaxClients(100);
+$server->setMaxConnectionsPerIp(20);
+$server->setMaxRequestsPerMinute(1000);
+
+$server->registerApplication('demo', \WebSocket\Application\DemoApplication::getInstance());
+$server->run();
+```
+## Authors
+
+The original maintainer and author was
+[@nicokaiser](https://github.com/nicokaiser). Plentiful improvements were
+contributed by [@lemmingzshadow](https://github.com/lemmingzshadow) and
+[@mazhack](https://github.com/mazhack). The server is licensed under the WTFPL,
+a free software compatible license.
+
+## Bugs/Todos/Hints
+
+- Add support for fragmented frames.
+- To report issues, see the [issue tracker](https://github.com/varspool/php-websocket/issues).
 
-## Demo
+## Examples
 
-- Check out http://jitt.li for a sample-project using this websocket server.
+- [Jitt.li](http://jitt.li), a Twitter API sample project.