a300ccdaad
This makes src/lib.rs the primary source for crate-level documentation. I've generated README.md with `cargo readme > README.md`. Since links to specific documentation items should be relative when possible, but must be absolute in README.md, I've used the new syntax for intra-rustdoc links (https://github.com/rust-lang/rfcs/blob/master/text/1946-intra-rustdoc-links.md), along with a README.tpl that sets up those links to point at the absolute versions. `cargo readme` uses the README.tpl by default. I've also rewritten the crate level docs, removing some TODO information at the bottom, and moving the license information to CONTRIBUTING.md.
23 lines
1.3 KiB
Smarty
23 lines
1.3 KiB
Smarty
[comment]: # (README.md is autogenerated from src/lib.rs by `cargo readme > README.md`)
|
|
|
|
# {{crate}}
|
|
|
|
{{readme}}
|
|
|
|
[rustls]: https://docs.rs/rustls/
|
|
[std::sync::Arc]: https://doc.rust-lang.org/stable/alloc/sync/struct.Arc.html
|
|
[std::io::Read]: https://doc.rust-lang.org/stable/std/io/trait.Read.html
|
|
[Agent]: https://docs.rs/ureq/latest/ureq/struct.Agent.html
|
|
[get()]: https://docs.rs/ureq/latest/ureq/fn.get.html
|
|
[post()]: https://docs.rs/ureq/latest/ureq/fn.post.html
|
|
[put()]: https://docs.rs/ureq/latest/ureq/fn.put.html
|
|
[Request]: https://docs.rs/ureq/latest/ureq/struct.Request.html
|
|
[Request::call()]: https://docs.rs/ureq/latest/ureq/struct.Request.html#method.call
|
|
[Request::send()]: https://docs.rs/ureq/latest/ureq/struct.Request.html#method.send
|
|
[Request::send_bytes()]: https://docs.rs/ureq/latest/ureq/struct.Request.html#method.send_bytes
|
|
[Request::send_string()]: https://docs.rs/ureq/latest/ureq/struct.Request.html#method.send_string
|
|
[Request::send_json()]: https://docs.rs/ureq/latest/ureq/struct.Request.html#method.send_json
|
|
[Request::send_form()]: https://docs.rs/ureq/latest/ureq/struct.Request.html#method.send_form
|
|
[Response::into_json()]: https://docs.rs/ureq/latest/ureq/struct.Response.html#method.into_json
|
|
[Response::into_string()]: https://docs.rs/ureq/latest/ureq/struct.Response.html#method.into_string
|