lib/ureq
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update README with http-interop feature

Browse Source
This commit is contained in:
Kade Robertson
2023-02-21 17:08:39 -05:00
committed by Martin Algesten
parent f4314e53ac
commit bdcee72c53
2 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -26,17 +26,17 @@ A simple, safe HTTP client.
Ureq's first priority is being easy for you to use. It's great for
anyone who wants a low-overhead HTTP client that just gets the job done. Works
very well with HTTP APIs. Its features include cookies, JSON, HTTP proxies,
HTTPS, and charset decoding.
HTTPS, interoperability with the `http` crate, and charset decoding.
Ureq is in pure Rust for safety and ease of understanding. It avoids using
`unsafe` directly. It [uses blocking I/O][blocking] instead of async I/O, because that keeps
the API simple and keeps dependencies to a minimum. For TLS, ureq uses
[rustls or native-tls](#https--tls--ssl).
Version 2.0.0 was released recently and changed some APIs. See the [changelog] for details.
See the [changelog] for details of recent releases.
[blocking]: #blocking-io-for-simplicity
[changelog]: https://github.com/algesten/ureq/blob/master/CHANGELOG.md
[changelog]: https://github.com/algesten/ureq/blob/main/CHANGELOG.md
### Usage
@@ -134,6 +134,7 @@ You can control them when including ureq as a dependency.
does nothing for `native-tls`.
* `gzip` enables requests of gzip-compressed responses and decompresses them. This is enabled by default.
* `brotli` enables requests brotli-compressed responses and decompresses them.
* `http-interop` enables conversion methods to and from `http::Response` and `http::request::Builder`.
## Plain requests

3
src/lib.rs
View File

@@ -37,7 +37,7 @@
//! Ureq's first priority is being easy for you to use. It's great for
//! anyone who wants a low-overhead HTTP client that just gets the job done. Works
//! very well with HTTP APIs. Its features include cookies, JSON, HTTP proxies,
//! HTTPS, and charset decoding.
//! HTTPS, interoperability with the `http` crate, and charset decoding.
//!
//! Ureq is in pure Rust for safety and ease of understanding. It avoids using
//! `unsafe` directly. It [uses blocking I/O][blocking] instead of async I/O, because that keeps
@@ -160,6 +160,7 @@
//! does nothing for `native-tls`.
//! * `gzip` enables requests of gzip-compressed responses and decompresses them. This is enabled by default.
//! * `brotli` enables requests brotli-compressed responses and decompresses them.
//! * `http-interop` enables conversion methods to and from `http::Response` and `http::request::Builder`.
//!
//! # Plain requests
//!