Skip to content

Commit

Permalink
add some basic crate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
seanmonstar committed Nov 16, 2023
1 parent 7a25e1a commit dedcc26
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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).
5 changes: 4 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
@@ -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;
Expand Down

0 comments on commit dedcc26

Please sign in to comment.