summaryrefslogtreecommitdiff
path: root/docs/about.md
diff options
context:
space:
mode:
authorGabriel Falcao <gabriel@nacaolivre.org>2013-10-10 13:47:41 -0400
committerGabriel Falcao <gabriel@nacaolivre.org>2013-10-10 13:47:41 -0400
commit7212f9db783a086a5156ddd4e888853f4f4eab7d (patch)
tree908f29c7dcd56b00d2e334b02096ceb7726bacff /docs/about.md
parent8995519e256bb31f3aaa65b2f9f72f3379d8868f (diff)
downloadhttpretty-7212f9db783a086a5156ddd4e888853f4f4eab7d.tar.gz
creating new docs
Diffstat (limited to 'docs/about.md')
-rw-r--r--docs/about.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/about.md b/docs/about.md
new file mode 100644
index 0000000..9dc6bbd
--- /dev/null
+++ b/docs/about.md
@@ -0,0 +1,18 @@
+# Acknowledgements
+
+## caveats with the [requests](http://docs.python-requests.org/en/latest/) library
+
+### `forcing_headers` + `Content-Length`
+
+if you use the `forcing_headers` options make sure to add the header
+`Content-Length` otherwise the
+[requests](http://docs.python-requests.org/en/latest/) will try to
+load the response endlessly
+
+# Officially supported libraries
+
+Because HTTPretty works in the socket level it should work with any HTTP client libraries, although it is [battle tested](https://github.com/gabrielfalcao/HTTPretty/tree/master/tests/functional) against:
+
+* [requests](http://docs.python-requests.org/en/latest/)
+* [httplib2](http://code.google.com/p/httplib2/)
+* [urllib2](http://docs.python.org/2/library/urllib2.html)