From 3b717eb5b8591b422c9f022f623d370e243e2549 Mon Sep 17 00:00:00 2001 From: Chris Boden Date: Wed, 10 Feb 2016 10:24:33 -0500 Subject: [PATCH] Documentation updates --- README.md | 15 +++++++-------- composer.json | 16 ++++++++-------- tests/ab/clientRunner.php | 2 +- 3 files changed, 16 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 95e8b4f..73aac8b 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,12 @@ # RFC6455 - The WebSocket Protocol -This library is meant to be a protocol handler for the RFC6455 specification. +[![Build Status](https://travis-ci.org/ratchetphp/RFC6455.svg?branch=master)](https://travis-ci.org/ratchetphp/RFC6455) ---- +This library a protocol handler for the RFC6455 specification. +It contains components for both server and client side handshake and messaging protocol negotation. -### A rough roadmap +Aspects that are left open to interpertation in the specification are also left open in this library. +It is up to the implementation to determine how those interpertations are to be dealt with. -* v0.1 is the initial split from Ratchet/v0.3.2 as-is. In this state it currently relies on some of Ratchet's interfaces. -* v0.2 will be more framework agnostic and will not require any interfaces from Ratchet. A dependency on Guzzle (or hopefully PSR-7) may be required. -* v0.3 will look into performance tuning. No more expected exceptions. -* v0.4 extension support -* v1.0 when all the bases are covered +This library is independent, framework agnostic, and does not deal with any I/O. +HTTP upgrade negotiation integration points are handled with PSR-7 interfaces. diff --git a/composer.json b/composer.json index 7d0f4e7..ffc15da 100644 --- a/composer.json +++ b/composer.json @@ -2,17 +2,17 @@ "name": "ratchet/rfc6455", "type": "library", "description": "RFC6455 protocol handler", - "keywords": ["WebSockets"], + "keywords": ["WebSockets", "websocket", "RFC6455"], "homepage": "http://socketo.me", "license": "MIT", - "authors": [ - { - "name": "Chris Boden", "email": "cboden@gmail.com", "role": "Developer" - } - ], + "authors": [{ + "name": "Chris Boden" + , "email": "cboden@gmail.com" + , "role": "Developer" + }], "support": { - "forum": "https://groups.google.com/forum/#!forum/ratchet-php", - "issues": "https://github.com/ratchetphp/RFC6455/issues", + , "forum": "https://groups.google.com/forum/#!forum/ratchet-php" + , "issues": "https://github.com/ratchetphp/RFC6455/issues" "irc": "irc://irc.freenode.org/reactphp" }, "autoload": { diff --git a/tests/ab/clientRunner.php b/tests/ab/clientRunner.php index 559a1aa..0c5578a 100644 --- a/tests/ab/clientRunner.php +++ b/tests/ab/clientRunner.php @@ -161,7 +161,7 @@ function createReport() { $rawResponse = ""; $response = null; - /** @var \Ratchet\RFC6455\Messaging\Streaming\MessageBuffer $ms */ + /** @var \Ratchet\RFC6455\Messaging\MessageBuffer $ms */ $ms = null; $stream->on('data', function ($data) use ($stream, &$rawResponse, &$response, &$ms, $cn, $deferred, &$context, $cnRequest) {