update-notifier

Library to notify you if there are any newer versions available on the registry

10 releases

0.1.9 Jul 10, 2020
0.1.8 May 29, 2020
Download history 10/week @ 2024-07-28 25/week @ 2024-09-22 3/week @ 2024-09-29

54 downloads per month
Used in 2 crates

MPL-2.0 license

16KB
291 lines

Update-notifier crates.io status

Update-notifier will notify your Rust CLI's users if there is an update available! You also have the freedom of setting the interval at which it will notify your users. This was built based on NPM's update-notifier

Usage

To use update-notifier, add this to your Cargo.toml:

[dependencies]
update-notifier = "0.1"

How to use

update-notifier::check_version takes the name and current version of your crate, along with an interval. It will print directly to stdout if the interval has been exceeded and an update is available

use update_notifier::check_version;
fn main() {
    // Will notify users in one day intervals if an update is available
    check_version(env!("CARGO_PKG_NAME"), env!("CARGO_PKG_VERSION"), Duration::from_secs(60 * 60 * 24));
}

Example

Example Image

Contributing

All contributions are welcome, feel free to file an issue or even a pull-request 🤝

Releases

Releases are done using cargo release. Check cargo-release for more information

License

This project is licensed under the Mozilla Public License 2.0

Dependencies

~10–19MB
~285K SLoC