From ae5779c1b9e4ca598b80fa0baea6a31563e16f34 Mon Sep 17 00:00:00 2001 From: Glenn Griffin Date: Tue, 10 Dec 2019 16:05:24 -0800 Subject: [PATCH] Update doc comments --- src/lib.rs | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index 5b05881..613f6eb 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,9 +1,12 @@ //! # httptest //! //! Provide convenient mechanism for testing http clients against a locally -//! running http server. This library consists of a number of components that -//! allow starting an http server and configuring it to expect to receive certain -//! requests and respond appropriately. +//! running http server. The typical usage is as follows: +//! +//! * Start a server +//! * Configure the server by adding expectations +//! * Test your http client by making requests to the server +//! * On Drop the server verifies all expectations were met. //! //! ## Example Test //!