diff --git a/.gitignore b/.gitignore index a9d37c56..eb20bc6e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ target Cargo.lock +.cargo/ diff --git a/Cargo.toml b/Cargo.toml index a4c75231..50ffa4fd 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,13 +1,13 @@ [package] edition = "2021" name = "bzip2" -version = "0.4.4" +version = "0.5.0" authors = ["Alex Crichton "] license = "MIT/Apache-2.0" readme = "README.md" keywords = ["bzip", "encoding"] -repository = "https://github.com/alexcrichton/bzip2-rs" -homepage = "https://github.com/alexcrichton/bzip2-rs" +repository = "https://github.com/trifectatechfoundation/bzip2-rs" +homepage = "https://github.com/trifectatechfoundation/bzip2-rs" documentation = "https://docs.rs/bzip2" description = """ Bindings to libbzip2 for bzip2 compression and decompression exposed as @@ -15,6 +15,7 @@ Reader/Writer streams. """ categories = ["compression", "api-bindings"] rust-version = "1.65.0" # MSRV +publish = true [workspace] diff --git a/README.md b/README.md index f383784b..90ec1333 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,19 @@ By default, `bzip2-rs` attempts to use the system `libbz2`. When `libbz2` is not is built from source. A from source build requires a functional C toolchain for your target, and may not work for all targets (in particular webassembly). +*`libbz2-rs-sys`* + +Since version 0.5.0, this crate also supports using [libbz2-rs-sys](https://crates.io/crates/libbz2-rs-sys), +a drop-in compatible rust implementation of `libbz2`. With this feature enabled, cross-compilation should work +like any other rust code, and no C toolchain is needed to compile this crate or its dependencies. + +```sh +bzip2 = { version = "0.5.0", default-features = false, features = ["libbz2-rs-sys"] } +``` + *`static`* -Always build `libbz2` from source, and statically link it. +Always build `libbz2` from source, and statically link it. When `libbz2-rs-sys` is enabled, static mode is always used. ## License