From 4d16a5493ea697b7e93765dd9033d946805ff865 Mon Sep 17 00:00:00 2001 From: Aron Heinecke Date: Sun, 14 Aug 2022 16:00:45 +0200 Subject: [PATCH] fixup doc links post initial debouncer-mini release --- notify-debouncer-mini/Cargo.toml | 4 ++-- notify-debouncer-mini/README.md | 9 ++++++--- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/notify-debouncer-mini/Cargo.toml b/notify-debouncer-mini/Cargo.toml index a3824b21..1eb1919a 100644 --- a/notify-debouncer-mini/Cargo.toml +++ b/notify-debouncer-mini/Cargo.toml @@ -1,10 +1,10 @@ [package] name = "notify-debouncer-mini" -version = "0.1.0" +version = "0.1.1" edition = "2021" rust-version = "1.56" description = "notify mini debouncer for events" -documentation = "https://docs.rs/notify_debouncer_mini" +documentation = "https://docs.rs/notify-debouncer-mini" homepage = "https://github.com/notify-rs/notify" repository = "https://github.com/notify-rs/notify.git" authors = ["Aron Heinecke "] diff --git a/notify-debouncer-mini/README.md b/notify-debouncer-mini/README.md index 5bdb7060..e59530ce 100644 --- a/notify-debouncer-mini/README.md +++ b/notify-debouncer-mini/README.md @@ -2,13 +2,16 @@ [![ยป Docs](https://flat.badgen.net/badge/api/docs.rs/df3600)][docs] -Tiny debouncer for notify. Filters incoming events and emits only one event per timeframe per file. +Tiny debouncer for [notify](https://crates.io/crates/notify). Filters incoming events and emits only one event per timeframe per file. ## Features - `crossbeam` enabled by default, for crossbeam channel support. This may create problems used in tokio environments. See [#380](https://github.com/notify-rs/notify/issues/380). -Use someting like `notify-debouncer-mini = { version = "*", default-features = false }` to disable it. +Use someting like the following to disable it. +```toml +notify-debouncer-mini = { version = "*", default-features = false } +``` - `serde` for serde support of event types, off by default -[docs]: https://docs.rs/notify/0.1/notify-debouncer-mini/ \ No newline at end of file +[docs]: https://docs.rs/notify-debouncer-mini \ No newline at end of file