From f1499ffb0ed7581f57ce465876fddee70efd9ba3 Mon Sep 17 00:00:00 2001 From: Chris Boden <cboden@gmail.com> Date: Sun, 29 Apr 2012 20:50:44 -0400 Subject: [PATCH] Updating readme --- README.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 5398c6b..570456d 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,6 @@ A PHP 5.3 (PSR-0 compliant) component library for serving sockets and building socket based applications. Build up your application through simple interfaces using the decorator and command patterns. Re-use your application without changing any of its code just by combining different components. -Ratchet's primary intention is to be used as a WebSocket server. ##WebSockets @@ -19,17 +18,14 @@ To avoid proxy/firewall blockage it's recommended WebSockets are run on port 80, Note that you can not run two applications (Apache and Ratchet) on the same port, thus the requirement for a separate machine (for now). Cookies from your domain will be passed to the socket server, allowing you to identify users. -Accessing your website's session data in Ratchet is a [feature in the works](https://github.com/cboden/Ratchet/tree/symfony/sessions). +Accessing your website's session data in Ratchet requires you to use [Symfony2 HttpFoundation Sessions](http://symfony.com/doc/master/components/http_foundation/sessions.html) on your website. + +### Documentation + +User and API documentation is available on Ratchet's website: http://socketo.me See https://github.com/cboden/Ratchet-examples for some out-of-the-box working demos using Ratchet. -###Future considerations - -Ideally, soon, web servers will start supporting WebSockets to some capacity and PHP will no longer need to run its self from the command line. -In theory, the server (like Nginx) would recognize the HTTP handshake request to upgrade the protocol to WebSockets and run/pass data through to a user -configured PHP file. When this happens, you can keep your script the same, just remove the IOServerComponent wrapper and maybe eventually the -WebSocketComponent wrapper if the servers recognize the protocol message framing. - --- ###A quick server example