Skip to content

Commit

Permalink
fixup doc links post initial debouncer-mini release
Browse files Browse the repository at this point in the history
  • Loading branch information
0xpr03 committed Aug 14, 2022
1 parent d698f90 commit 4d16a54
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
4 changes: 2 additions & 2 deletions notify-debouncer-mini/Cargo.toml
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>"]
Expand Down
9 changes: 6 additions & 3 deletions notify-debouncer-mini/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/
[docs]: https://docs.rs/notify-debouncer-mini

0 comments on commit 4d16a54

Please sign in to comment.