⚠️ Is your feature request related to a problem? Please describe

Currently there is some inconsistency in having README in develop branch.
In case of adding some feature and its description into develop users see this description and think that this feature is available in the latest stable release, while it might be not released yet. Such situation happened recently.
Also, Chuc

In the current README, so far I've gone over the very basics. Not all features have been covered, and there is little talk about httpu packages. Maybe some wiki pages, and some more details on the README would be helpful. Also a much better example video / gif is needed, the one I made is pretty bad.

Request has a .form() function that can be called for multipart form data, documented:

https://github.com/request/request#forms

There are other ways to submit mulitpart forms (e.g. using the formData parameter) but as this is intended as a drop-in replace for request, it should expose that function too

The types returned from each method/attribute are really confusing - for example here:

> platform = ua.device.platform
=> "iPhone"

where ua.device.platform actually returns a AgentOrange::Platform object. Am I missing something? Documenting with YARD would be awesome, too...

http://rubydoc.info/gems/ag

It looks like the example links on the readme are broken.
Things like "Example run with console output" go to a page that says "Cannot proxy the given URL".

Thank you :)

After the switch to Netty in 3.1.X+ some response headers are not prefixed with "http_".

Previously, it appears that Puma (and Mongrel) added this prefix.

Users that depend on a field http_x_forwarded_for to do geoip lookup will have failures as the field is now x_forwarded_for.