Add sentence to summary

fornwall · Sep 21, 2023 · 97fedeb · 97fedeb
1 parent 56ce3f6
commit 97fedeb
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "allocation-counter"
-version = "0.8.0"
+version = "0.8.1"
 authors = ["Fredrik Fornwall <fredrik@fornwall.net>"]
 categories = ["development-tools", "memory-management"]
 description = "Count the number of memory allocation of some code."

diff --git a/src/lib.rs b/src/lib.rs
@@ -1,8 +1,12 @@
 /*!
 This crate provides a method to measure memory allocations while running some code.
 
+It can be used either exploratory (obtaining insights in how much memory allocations
+are being made), or as a tool to assert desired allocation behaviour in tests.
+
 # Usage
-Add as a dependency - since including the trait replaces the global memory allocator, you most likely want it gated behind a feature.
+Add as a dependency - since including the trait replaces the global memory allocator,
+you most likely want it gated behind a feature.
 
 ```toml
 [features]