From 4179587f02cf8b12bd8e81173fecf08e21cbe04d Mon Sep 17 00:00:00 2001 From: Sean McArthur Date: Thu, 16 Nov 2023 13:39:01 -0500 Subject: [PATCH] add some basic crate docs (#55) --- README.md | 6 +++++- src/lib.rs | 5 ++++- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6f2d14a..6921191 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ # hyper-util -A collection of utilities to be do common things with hyper. +A collection of utilities to do common things with [hyper](https://hyper.rs). + +## License + +This project is licensed under the [MIT license](./LICENSE). diff --git a/src/lib.rs b/src/lib.rs index 8fa7f26..d720762 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,7 +1,10 @@ #![deny(missing_docs)] #![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))] -//! hyper-util +//! Utilities for working with hyper. +//! +//! This crate is less-stable than [`hyper`](https://docs.rs/hyper). However, +//! does respect Rust's semantic version regarding breaking changes. #[cfg(feature = "client")] pub mod client;