Merge pull request #35 from jeremyandrews/docs

release 0.2.0
tag1consulting · Oct 5, 2021 · 77edb18 · 77edb18
2 parents c77c494 + c69723f
commit 77edb18
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Changelog
 
-## 0.2.0-dev
+## 0.2.0 October 5, 2021
  - **API change**: update goose to [0.14](https://github.com/tag1consulting/goose/releases/tag/0.14.0)
 
 ## 0.1.12 August 22, 2021

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "goose-eggs"
-version = "0.2.0-dev"
+version = "0.2.0"
 authors = ["Jeremy Andrews <[email protected]>"]
 edition = "2018"
 description = "Helpful in writing Goose load tests."

diff --git a/README.md b/README.md
@@ -10,4 +10,5 @@ Helpful in writing [`Goose`](https://docs.rs/goose) load tests.
 ## Documentation
 
 - [Goose Eggs](https://docs.rs/goose-eggs)
-- [Umami example](https://github.com/tag1consulting/goose-eggs/tree/main/examples/umami)
+- [Goose Eggs Umami example](https://github.com/tag1consulting/goose-eggs/tree/main/examples/umami)
+- [The Goose book](https://book.goose.rs/)
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,4 +1,10 @@
-//! Goose Eggs are helpful in writing [`Goose`](https://docs.rs/goose) load tests.
+//! Goose Eggs are helpful in writing [`Goose`](https://book.goose.rs/) load tests.
+//!
+//! ## Example
+//! The [Umami example](https://github.com/tag1consulting/goose/tree/main/examples/umami)
+//! included with Goose has been [converted to use the Goose Eggs library](https://github.com/tag1consulting/goose-eggs/tree/main/examples/umami)
+//! and serves as a useful example on how to leverage it when writing load tests.
+
 use goose::goose::GooseResponse;
 use goose::prelude::*;
 use log::info;