X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=http.md;h=0d483fa8bbbc4a17c5f7d5a5b69361d8b063dcc1;hb=d0739155d521d20151f8a0b401c586e6325babbd;hp=f439b0d281fd2bcbace3fbb48534385b5412d6ee;hpb=d5af35badf0c029ba85f9b53b78bcd5a01907a8d;p=mdref%2Fmdref-http

diff --git a/http.md b/http.md
index f439b0d..0d483fa 100644
--- a/http.md
+++ b/http.md
@@ -1,20 +1,122 @@
-# pecl/http v2
+# pecl/http
 
-> **Note:** This documentation is work-in-progress.
+## About:
 
-## About
-
-Extended HTTP support. Again. Keep in mind that it's got the major version 2, because it's incompatible with pecl_http v1.
+Extended HTTP support. Again. 
 
 * Introduces the http namespace.
-* Message bodies have been remodeled to use PHP temporary streams instead of in-memory buffers.
-* The utterly misunderstood HttpResponse class has been reimplemented as http\Env\Response inheriting http\Message.
-* Currently, there's only one Exception class left, http\Exception.
-* Errors triggered by the extension can be configured statically by http\Object::$defaultErrorHandling or inherited http\Object->errorHandling.
-* The request ecosystem has been modularized to support different libraries, though for the moment only libcurl is supported.
+* PHP stream based message bodies.
+* Encapsulated env request/response.
+* Modular client support.
+
+## Installation:
+
+This extension is hosted at [PECL](http://pecl.php.net) and can be installed with [PEAR](http://pear.php.net)'s pecl command:
+
+    # pecl install pecl_http
+
+## Dependencies:
+
+pecl/http depends on a number of system libraries and PHP extensions for special features.
+
+#### Required system libraries:
+
+The following system libraries are required to build this extension:
+
+=zlib=
+	Provides gzip/zlib/deflate encoding.  
+	Minimum version: 1.2.0.4  
+	Install on Debian: `apt-get install zlib1g-dev`
+
+
+#### Optional system libraries:
+
+The following system libraries are optional and provide additional features:
+
+=libidn=
+	Provides IDNA support in URLs.  
+	Minimum version: none  
+	Install on Debian: `apt-get install libidn11-dev`
+
+=libidn2=
+	Provides IDNA support in URLs (fallback if libidn is not available).  
+	Minimum version: none  
+	Install on Debian: `apt-get install libidn2-0-dev`
+
+=libicu=
+	Provides IDNA support in URLs (fallback if libidn is not available).  
+	Minimum version: none  
+	Install on Debian: `apt-get install libicu-dev`
+
+=libcurl=
+	Provides HTTP request functionality.  
+	Minimum version: 7.18.2  
+	Install on Debian: `apt-get install libcurl4-openssl-dev`  
+	Note: There are usually different styles of SSL support for libcurl available, so you can replace 'openssl' in the above command f.e. with 'nss' or 'gnutls'.
+
+=libevent=
+	Eventloop support for the HTTP client.  
+	Minimum version: none  
+	Install on Debian: `apt-get install libevent-dev`
+
+### PHP extensions:
+
+This extension unconditionally depends on the pre-loaded presence of the following PHP extensions:
+
+* raphf
+* propro
+* spl
+
+
+If configured ```--with-http-shared-deps``` (default) it depends on the pre-loaded presence of the following extensions, as long as they were available at build time:
+
+* hash
+* iconv
+* json (only until < 2.4.0)
+
+Please ensure that all extension on which pecl/http depends, are loaded before it, e.g in your `php.ini`:
+
+	; obligatory deps
+	extension = raphf.so
+	extension = propro.so
+	
+	; if shared deps were enabled
+	extension = hash.so
+	extension = iconv.so
+	extension = json.so
+	
+	; finally load pecl/http
+	extension = http.so
+
+## Conflicts:
+
+pecl/http-v2 conflicts with the following extensions:
+
+* http-v1
+* event (only until <= 2.0.3)
 
 ## INI Directives:
 
 * http.etag.mode = "crc32b"  
   Default hash method for dynamic response payloads to generate an ETag.
 
+## Stream Filters:
+
+The http extension registers the ```http.*``` namespace for its stream filters. Provided stream filters are:
+
+* http.chunked_decode  
+  Decode a stream encoded with chunked transfer encoding.
+* http.chunked_encode  
+  Encode a stream with chunked transfer encoding.
+* http.inflate  
+  Decode a stream encoded with deflate/zlib/gzip encoding.
+* http.deflate  
+  Encode a stream with deflate/zlib/gzip encoding.
+
+## Changelog:
+
+Version | Change
+--------|-------
+2.0.4   | Dropped the pecl/event conflict.
+2.4.0   | Dropped the ext/json dependency.
+2.4.2   | Added libidn2 and libicu as fallback for IDNA support.