diff --git a/CHANGELOG.md b/CHANGELOG.md index 943ef09..f7ea5a0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +# Version 0.2.0 (2024-03-06) + +This release makes a breaking change to the library API. `run()` and `is_update_needed()` are now both async methods; new `run_sync()` and `is_update_needed_sync()` methods have been added which replicate the old behaviour. This should make it easier to incorporate the axoupdater library into asynchronous applications, especially applications which already use tokio. + +To use the blocking methods, enable the `blocking` feature when importing this crate as a library. + # Version 0.1.0 (2024-03-01) This is the initial release of axoupdater, including both the standalone binary and the library for embedding in other binaries. diff --git a/Cargo.lock b/Cargo.lock index b86acbb..45906ea 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -116,7 +116,7 @@ dependencies = [ [[package]] name = "axoupdater" -version = "0.1.0" +version = "0.2.0" dependencies = [ "axoasset 0.7.0", "axoprocess", @@ -133,7 +133,7 @@ dependencies = [ [[package]] name = "axoupdater-cli" -version = "0.1.0" +version = "0.2.0" dependencies = [ "axocli", "axoupdater", diff --git a/Cargo.toml b/Cargo.toml index 9689f5c..1871a29 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,7 +3,7 @@ members = ["axoupdater", "axoupdater-cli"] resolver = "2" [workspace.package] -version = "0.1.0" +version = "0.2.0" edition = "2021" license = "MIT OR Apache-2.0" homepage = "https://github.com/axodotdev/axoupdater" diff --git a/README.md b/README.md index bd62949..b43b97b 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ if AxoUpdater::new_for("axolotlsay").load_receipt()?.run_sync()? { } ``` -Asynchronous versions of `is_update_needed()` and `run()` are also provided: +To use the blocking versions of the methods, make sure to enable the `"blocking"` feature on this dependency in your `Cargo.toml`. Asynchronous versions of `is_update_needed()` and `run()` are also provided: ```rust if AxoUpdater::new_for("axolotlsay").load_receipt()?.run().await? { diff --git a/axoupdater-cli/Cargo.toml b/axoupdater-cli/Cargo.toml index 570680f..1e442be 100644 --- a/axoupdater-cli/Cargo.toml +++ b/axoupdater-cli/Cargo.toml @@ -12,7 +12,7 @@ readme = "../README.md" [dependencies] axocli = "0.2.0" -axoupdater = { version = "=0.1.0", path = "../axoupdater", features = ["blocking"] } +axoupdater = { version = "=0.2.0", path = "../axoupdater", features = ["blocking"] } # errors miette = "7.1.0"