Skip to content

Commit 4179587

Browse files
authored
add some basic crate docs (#55)
1 parent 7a25e1a commit 4179587

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
# hyper-util
22

3-
A collection of utilities to be do common things with hyper.
3+
A collection of utilities to do common things with [hyper](https://hyper.rs).
4+
5+
## License
6+
7+
This project is licensed under the [MIT license](./LICENSE).

src/lib.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
#![deny(missing_docs)]
22
#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
33

4-
//! hyper-util
4+
//! Utilities for working with hyper.
5+
//!
6+
//! This crate is less-stable than [`hyper`](https://docs.rs/hyper). However,
7+
//! does respect Rust's semantic version regarding breaking changes.
58
69
#[cfg(feature = "client")]
710
pub mod client;

0 commit comments

Comments
 (0)