Skip to content

Commit

Permalink
prepare release 0.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
folkertdev committed Dec 11, 2024
1 parent fe3a545 commit 0d8cb2a
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 4 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
target
Cargo.lock
.cargo/
7 changes: 4 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
[package]
edition = "2021"
name = "bzip2"
version = "0.4.4"
version = "0.5.0"
authors = ["Alex Crichton <[email protected]>"]
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
Reader/Writer streams.
"""
categories = ["compression", "api-bindings"]
rust-version = "1.65.0" # MSRV
publish = true

[workspace]

Expand Down
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 0d8cb2a

Please sign in to comment.