From 7cf3f6eca2a4309d6ce7b987e661c7945653d607 Mon Sep 17 00:00:00 2001 From: pantonshire Date: Thu, 17 Aug 2023 09:20:12 +0100 Subject: [PATCH] update Cargo.toml and start writing README --- Cargo.toml | 2 ++ README.md | 13 +++++++++++++ 2 files changed, 15 insertions(+) create mode 100644 README.md diff --git a/Cargo.toml b/Cargo.toml index 59331fc..28c9694 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -6,5 +6,7 @@ authors = ["Tom Panton "] license = "MIT" repository = "https://github.com/pantonshire/treacle" description = "Event debouncer" +readme = "README.md" +keywords = ["debounce", "debouncer"] [dependencies] diff --git a/README.md b/README.md new file mode 100644 index 0000000..996f9a8 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# `treacle` +A generic event debouncer for Rust, for grouping events which occur close together in time into a +single event. + +For example, you may have some +[templates](https://www.arewewebyet.org/topics/templating/) +which you want to reload whenever a template file changes. However, if many small changes are made +to the template files in quick succession, it would be wasteful to reload the templates for every +change; instead, a debouncer could be used to group the changes that occur at a similar time into +a single change, so the templates are only reloaded once. + +## Usage +