Updated doc

This commit is contained in:
Tatsuhiro Tsujikawa 2012-04-25 21:25:51 +09:00
parent 333514021d
commit 9c40b5cce6
2 changed files with 30 additions and 24 deletions

View File

@ -1,19 +1,18 @@
Spdylay - SPDY C Library Spdylay - SPDY C Library
======================== ========================
This is an experimental implementation of Google's SPDY protocol This is an experimental implementation of Google's SPDY protocol in C.
version 2 and 3 in C.
This library provides SPDY framing layer implementation. It does not This library provides SPDY version 2 and 3 framing layer
perform any I/O operations. When the library needs them, it calls the implementation. It does not perform any I/O operations. When the
callback functions provided by the application. It also does not library needs them, it calls the callback functions provided by the
include any event polling mechanism, so the application can freely application. It also does not include any event polling mechanism, so
choose the way of handling events. This library code does not depend the application can freely choose the way of handling events. This
on any particular SSL library (except for example programs which library code does not depend on any particular SSL library (except for
depend on OpenSSL 1.0.1 or later). 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 Most of the SPDY/2 and SPDY/3 functionality has been implemented. In
both versions, the direct support of server-push has not been both versions, the direct support of server-push has not been

View File

@ -3,23 +3,25 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
Welcome to Spdylay's documentation! Spdylay - SPDY C Library
=================================== ========================
This is an experimental implementation of Google's SPDY protocol This is an experimental implementation of Google's SPDY protocol in C.
version 2 and 3 in C.
This library provides SPDY framing layer implementation. It does not .. hlist::
perform any I/O operations. When the library needs them, it calls the :columns: 3
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).
The project is hosted at https://sourceforge.net/projects/spdylay/. * `Download <http://sourceforge.net/projects/spdylay/files/stable/>`_
* `Sourceforge.net <http://sourceforge.net/projects/spdylay>`_
* `Source <https://github.com/tatsuhiro-t/spdylay>`_
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: Contents:
@ -27,3 +29,8 @@ Contents:
:maxdepth: 2 :maxdepth: 2
apiref apiref
Resources
---------
* http://www.chromium.org/spdy