Skip to content

Commit

Permalink
prepare release 0.5.0
Browse files Browse the repository at this point in the history
also includes:

Update LICENSE-MIT

Update copyright line for clarity:
- Alex has been making modifications since 2014
- presumably no (c)-transfer has been arranged so copyright also belongs to the other contributors to this repo.
- Trifecta has also made some modifications, but these are relatively small and so I see no need to add a separate "Copyright (c) 2024 Trifecta Tech Foundation" line right now.

remove authors field from cargo.toml

use of this field is discouraged at this point https://rust-lang.github.io/rfcs/3052-optional-authors-field.html

update license syntax

Co-authored-by: Marc R. Schoolderman <[email protected]>
  • Loading branch information
folkertdev and squell committed Dec 11, 2024
1 parent 5a425ed commit bdb6e22
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 7 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/
10 changes: 5 additions & 5 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
[package]
edition = "2021"
name = "bzip2"
version = "0.4.4"
authors = ["Alex Crichton <[email protected]>"]
license = "MIT/Apache-2.0"
version = "0.5.0"
license = "MIT OR 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
2 changes: 1 addition & 1 deletion LICENSE-MIT
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2014 Alex Crichton
Copyright (c) 2014-2024 Alex Crichton and Contributors

Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated
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 bdb6e22

Please sign in to comment.