From 9c40b5cce6ac8314d13723bd6d6ed90ce1d37338 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Wed, 25 Apr 2012 21:25:51 +0900 Subject: [PATCH] Updated doc --- README.rst | 21 ++++++++++----------- doc/index.rst | 33 ++++++++++++++++++++------------- 2 files changed, 30 insertions(+), 24 deletions(-) diff --git a/README.rst b/README.rst index 8743e92d..3d0e6098 100644 --- a/README.rst +++ b/README.rst @@ -1,19 +1,18 @@ Spdylay - SPDY C Library ======================== -This is an experimental implementation of Google's SPDY protocol -version 2 and 3 in C. +This is an experimental implementation of Google's SPDY protocol in C. -This library provides SPDY framing layer implementation. It does not -perform any I/O operations. When the library needs them, it calls the -callback functions provided by the application. It also does not -include any event polling mechanism, so the application can freely -choose the way of handling events. This library code does not depend -on any particular SSL library (except for example programs which -depend on OpenSSL 1.0.1 or later). +This library provides SPDY version 2 and 3 framing layer +implementation. It does not perform any I/O operations. When the +library needs them, it calls the callback functions provided by the +application. It also does not include any event polling mechanism, so +the application can freely choose the way of handling events. This +library code does not depend on any particular SSL library (except for +example programs which depend on OpenSSL 1.0.1 or later). -STATUS ------- +Development Status +------------------ Most of the SPDY/2 and SPDY/3 functionality has been implemented. In both versions, the direct support of server-push has not been diff --git a/doc/index.rst b/doc/index.rst index 5ccfaf83..2d89666c 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -3,23 +3,25 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Spdylay's documentation! -=================================== +Spdylay - SPDY C Library +======================== -This is an experimental implementation of Google's SPDY protocol -version 2 and 3 in C. +This is an experimental implementation of Google's SPDY protocol in C. -This library provides SPDY framing layer implementation. It does not -perform any I/O operations. When the library needs them, it calls the -callback functions provided by the application. It also does not -include any event polling mechanism, so the application can freely -choose the way of handling events. This library code does not depend -on any particular SSL library (except for example programs which -depend on OpenSSL 1.0.1 or later). +.. hlist:: + :columns: 3 -The project is hosted at https://sourceforge.net/projects/spdylay/. + * `Download `_ + * `Sourceforge.net `_ + * `Source `_ -The source code is hosted at https://github.com/tatsuhiro-t/spdylay. +This library provides SPDY version 2 and 3 framing layer +implementation. It does not perform any I/O operations. When the +library needs them, it calls the callback functions provided by the +application. It also does not include any event polling mechanism, so +the application can freely choose the way of handling events. This +library code does not depend on any particular SSL library (except for +example programs which depend on OpenSSL 1.0.1 or later). Contents: @@ -27,3 +29,8 @@ Contents: :maxdepth: 2 apiref + +Resources +--------- + +* http://www.chromium.org/spdy