From 3d343497628ca07be11ad589b349d73c297d934f Mon Sep 17 00:00:00 2001 From: Sven Slootweg Date: Fri, 23 Jan 2015 18:38:51 +0100 Subject: [PATCH] Documentation updates --- README.md | 6 +++++- package.json | 2 +- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ffbf680..d5f9a9e 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,10 @@ All these issues (and more) are solved in `bhttp`. It offers the following: * Streaming requests are kept out of the agent pool - ie. no blocking of other requests. * Optionally, a Promises API (you can also use nodebacks). +## Caveats + +* `bhttp` does not yet use a HTTPS-capable agent. This means that all SSL-related options are currently ignored (per Node.js `http` documentation). If you need secure HTTPS requests, make sure to specify a custom agent! + ## License [WTFPL](http://www.wtfpl.net/txt/copying/) or [CC0](https://creativecommons.org/publicdomain/zero/1.0/), whichever you prefer. A donation and/or attribution are appreciated, but not required. @@ -103,7 +107,7 @@ Convenience methods that pre-set the request method, and automatically send alon * __url__: The URL to request, with protocol. When using HTTPS, please be sure to read the 'Caveats' section. * __data__: *Optional, only for POST/PUT/PATCH.* The payload to send along. -* __options__: *Optional.* Extra options for the request. More details under the documentation forthe `bhttp.request` method below. +* __options__: *Optional.* Extra options for the request. More details under the documentation for the `bhttp.request` method below. * __callback__: *Optional.* When using the nodeback API, the callback to use. If not specified, a Promise will be returned. The `data` payload can be one of the following things: diff --git a/package.json b/package.json index 024c17e..b0a34aa 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "bhttp", - "version": "1.0.0", + "version": "1.0.1", "description": "A sane HTTP client library for Node.js with Streams2 support.", "main": "index.js", "scripts": {