1 files changed, 91 insertions, 36 deletions

diff --git a/README b/README
index 179338bf..5beded78 100644
--- a/README
+++ b/README
@@ -7,6 +7,11 @@ is also supported).  GNU libmicrohttpd only implements the HTTP 1.1
 protocol.  The main application must still provide the application
 logic to generate the content.
 
+Additionally, a second, still very experimental library is provided
+for SPDY/HTTP 2.0 support.  libmicrospdy provides a compact API and
+implementation of SPDY server. libmicrospdy currently only implements
+version 3 of SPDY and accepts only TLS connections.
+
 
 Installation
 ============
@@ -20,6 +25,21 @@ Especially for development, do use the MHD_USE_DEBUG option to get
 error messages.
 
 
+Requirements for libmicrospdy
+=============================
+
+The following packages are needed to build libmicrospdy:
+
+* zlib 
+* OpenSSL >= 1.0.1
+
+To run the test cases, involving requests, version of Spdylay, supporting
+SPDY v3, is required. Spdylay is still under development and can be
+found here:
+
+http://spdylay.sourceforge.net/
+
+
 Configure options
 =================
 
@@ -53,58 +73,93 @@ must call "MHD_init" before using any MHD functions and "MHD_fini"
 after you are done using MHD.
 
 
-Notes on compiling on z/OS:
----------------------------
-
-After extracting the archive, run
-
-iconv -f UTF-8 -t IBM-1047 contrib/ascebc > /tmp/ascebc.sh
-chmod +x /tmp/ascebc.sh
-for n in `find * -type f`
-do
-  /tmp/ascebc.sh $n
-done
-
-to convert all source files to EBCDIC.  Note that you must run
-"configure" from the directory where the configure script is
-located.   Otherwise, configure will fail to find the
-"contrib/xcc" script (which is a wrapper around the z/OS c89
-compiler).
-
-
 Development Status
 ==================
 
-This is a beta release.  Below we list things that should be
-implemented (in order of importance) before we can claim to be
-reasonably complete.
-
+This is a beta release for libmicrohttpd.  Before declaring the
+library stable, we should implement support for HTTP "Upgrade" 
+requests and have testcases for the following features:
 
-Untested features:
-==================
-- add testcases for http/1.1 pipelining (need
-  to figure out how to ensure curl pipelines 
+- HTTP/1.1 pipelining (need to figure out how to ensure curl pipelines 
   -- and it seems libcurl has issues with pipelining, 
   see http://curl.haxx.se/mail/lib-2007-12/0248.html)
-- add testcases for resource limit enforcement
-- add testcases for client queuing early response,
-  suppressing 100 CONTINUE
-- extend testcase for chunked encoding to validate
-  handling of footers
+- resource limit enforcement
+- client queuing early response, suppressing 100 CONTINUE
+- chunked encoding to validate handling of footers
 - more testing for SSL support
 - MHD basic and digest authentication
 
-
-Functions not covered by "make check":
-======================================
+In particular, the following functions are not covered by 'make check':
 - mhd_panic_std (daemon.c); special case (abort)
 - parse_options (daemon.c)
 - MHD_set_panic_func (daemon.c)
 - MHD_get_version (daemon.c)
 
 
+This is an early alpha release for libmicrospdy.  The following things
+should be implemented (in order of importance) before we can claim to
+be reasonably complete:
+- Change session timeout to use not seconds but something more precise
+- SPDY RST_STREAM sending on each possible error (DONE?)
+- SPDY_close_session
+- Find the best way for closing still opened stream (new call or existing)
+- SPDY_is_stream_opened
+- SPDY PING (used often by browsers)
+- SPDY WINDOW_UPDATE - used often by browsers
+- SPDY Settings
+- SPDY PUSH
+- SPDY HEADERS
+- HTTP POST over SPDY and receiving DATA frames
+- HTTP PUT over SPDY
+- SPDY Credentials
+
+Additional ideas for features include:
+- Individual callbacks for each session
+- Individual timeout for each session
+- Setting number of frames that can be written to the output at once. 
+  A big number means faster sending of a big resource, but the other 
+  sessions will wait longer.
+
+Unimplemented API functions of libmicrospdy:
+- SPDY_settings_create ();
+- SPDY_settings_add (...);
+- SPDY_settings_lookup (...);
+- SPDY_settings_iterate (...);
+- SPDY_settings_destroy (...);
+- SPDY_close_session(...);
+- SPDY_send_ping(...);
+- SPDY_send_settings (...);
+
+In particular, we should write tests for:
+- Enqueueing responses while considering request priorities.
+
+
+
+
+
 Missing documentation:
 ======================
 
-- manual:
+- libmicrohttpd manual:
   * document details on porting MHD (plibc, z/OS)
+- libmicrospdy manual:
+  * missing entirely
+
+
+Notes on compiling on z/OS:
+===========================
+
+After extracting the archive, run
+
+iconv -f UTF-8 -t IBM-1047 contrib/ascebc > /tmp/ascebc.sh
+chmod +x /tmp/ascebc.sh
+for n in `find * -type f`
+do
+  /tmp/ascebc.sh $n
+done
+
+to convert all source files to EBCDIC.  Note that you must run
+"configure" from the directory where the configure script is
+located.   Otherwise, configure will fail to find the
+"contrib/xcc" script (which is a wrapper around the z/OS c89
+compiler).