diff --git a/Cargo.toml b/Cargo.toml index 0914c457..e62d335a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "notify" -version = "3.0.1" +version = "4.0.0" authors = [ "Félix Saparelli ", "Jorge Israel Peña ", diff --git a/README.md b/README.md index 965873da..fd074bff 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ As used by: [cargo watch], [cobalt], [handlebars-iron], [rdiff], and ```toml [dependencies] -notify = "3.0.1" +notify = "4.0.0" ``` ## Usage @@ -66,29 +66,29 @@ fn main() { The documentation for the previous major version is [available on docs.rs][docs-v2]. While version 2.x will no longer be maintained and we -encourage all library authors to switch to version 3 (a short guide is provided -below), it is still a dependency of many packages. Here is a list of changes -you may need to take note of: +encourage all library authors to switch to version 3+ (a short guide is +provided below), it is still a dependency of many packages. Here is a list of +changes you may need to take note of: - Notify 2.x by default provided the events immediately as reported from the - backend API. Notify 3.x by default [debounces the events][docs-debounce] — if + backend API. Notify 3+ by default [debounces the events][docs-debounce] — if the backend reports two similar events in close succession, Notify will only report one. The old behaviour may be obtained through the `Watcher::new_raw()` function and `RawEvent` type, see [the documentation][docs-raw]. - Notify 2.x always tried to watch paths recursively in the case of - directories. Notify 3.x gives you the choice of what mode you'd like to use + directories. Notify 3+ gives you the choice of what mode you'd like to use per-watch, using the [`RecursiveMode`][docs-recursivemode] enum. The `watch(...)` function thus takes the mode as a second argument. - Notify 2.x had two behaviour bugs with the **inotify** backend, that are - corrected in Notify 3.x. Nonetheless, these are breaking changes: + corrected in Notify 3+. Nonetheless, these are breaking changes: * **inotify** did not _remove_ watches recursively; and * **inotify** did not watch _newly created folders_. -To upgrade to Notify 3.x with minimal behaviour change: +To upgrade to Notify 3+ with minimal behaviour change: - Replace `Watcher::new` with `Watcher::new_raw`. - Replace `Event` with `EventRaw`. @@ -138,7 +138,7 @@ Public Domain using the [Creative Commons Zero Declaration][cc0]. [crate]: https://crates.io/crates/notify [docs-debounce]: https://docs.rs/notify/#default-debounced-api [docs-raw]: https://docs.rs/notify/#raw-api -[docs-recursivemode]: https://docs.rs/notify/3.0.1/notify/enum.RecursiveMode.html +[docs-recursivemode]: https://docs.rs/notify/*/notify/enum.RecursiveMode.html [docs-v2]: https://docs.rs/notify/2 [docs]: https://docs.rs/notify [fsnotify]: https://github.com/go-fsnotify/fsnotify diff --git a/src/lib.rs b/src/lib.rs index b0203e6c..81d4df7c 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -6,7 +6,7 @@ //! //! ```toml //! [dependencies] -//! notify = "^3.0.0" +//! notify = "4.0.0" //! ``` //! //! # Examples