diff --git a/README.md b/README.md index d67064b5..dd6cf11c 100644 --- a/README.md +++ b/README.md @@ -1 +1,101 @@ -Read me +# HTTPX: A Ruby HTTP HTTPX for tomorrow... and beyond! + +HTTPX is an HTTP client library for the Ruby programming language. + +Among its features, it supports: + +* HTTP/2 and HTTP/1.x protocol versions +* Concurrent requests by default +* Simple and chainable API (based on HTTP.rb, itself based on Python Requests) +* Proxy Support (HTTP(S), Socks4/4a/5) +* Simple Timeout System +* Lightweight (explicit feature loading) + +And among others + +* Compression (gzip, deflate, brotli) +* Authentication (Basic Auth, Digest Auth) +* Cookies +* HTTP/2 Server Push +* H2C Upgrade +* Redirect following + +## Installation + +Add this line to your Gemfile: + +```ruby +gem "httpx" +``` + +or install yourself: + +``` +> gem install httpx +``` + +and then just require in your program: + +```ruby +require "httpx" +``` + +## How + +Here are some simple examples: + +```ruby +HTTPX.get("https://nghttp2.org").to_s #=> " 200 +body = response.body +puts body #=> #