README.md in httpx-0.10.2 vs README.md in httpx-0.11.0
- old
+ new
@@ -1,9 +1,9 @@
# HTTPX: A Ruby HTTP library for tomorrow... and beyond!
[](http://rubygems.org/gems/httpx)
-[](https://gitlab.com/honeyryderchuck/httpx/commits/master)
+[](https://gitlab.com/honeyryderchuck/httpx/pipelines?page=1&scope=all&ref=master)
[](https://honeyryderchuck.gitlab.io/httpx/coverage/#_AllFiles)
HTTPX is an HTTP client library for the Ruby programming language.
Among its features, it supports:
@@ -83,12 +83,20 @@
However if the server supports HTTP/1.1, it will try to use HTTP pipelining, falling back to 1 request at a time if the server doesn't support it (if the server support Keep-Alive connections, it will reuse the same connection).
### Clean API
-`HTTPX` acknowledges the ease-of-use of the [http gem](https://github.com/httprb/http) API (itself inspired by python [requests](http://docs.python-requests.org/en/latest/) library). It therefore aims at reusing the same facade, extending it for the use cases which the http gem doesn't support.
+`httpx` builds all functions around the `HTTPX` module, so that all calls can compose of each other. Here are a few examples:
+```ruby
+response = HTTPX.get("https://www.google.com")
+response = HTTPX.post("https://www.nghttp2.org/httpbin/post", params: {name: "John", age: "22"})
+response = HTTPX.plugin(:basic_authentication)
+ .basic_authentication("user", "pass")
+ .get("https://www.google.com")
+```
+
### Lightweight
It ships with a plugin system similar to the ones used by [sequel](https://github.com/jeremyevans/sequel), [roda](https://github.com/jeremyevans/roda) or [shrine](https://github.com/janko-m/shrine).
It means that it loads the bare minimum to perform requests, and the user has to explicitly load the plugins, in order to get the features he/she needs.
@@ -133,9 +141,9 @@
## Contributing
* Discuss your contribution in an issue
* Fork it
-* Make your changes, add some test
+* Make your changes, add some tests
* Ensure all tests pass (`bundle exec rake test`)
* Open a Merge Request (that's Pull Request in Github-ish)
* Wait for feedback