diff --git a/README.md b/README.md index 18df346f..26c5ff79 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![crate](https://img.shields.io/crates/v/num-bigint.svg)](https://crates.io/crates/num-bigint) [![documentation](https://docs.rs/num-bigint/badge.svg)](https://docs.rs/num-bigint) [![minimum rustc 1.60](https://img.shields.io/badge/rustc-1.60+-red.svg)](https://rust-lang.github.io/rfcs/2495-min-rust-version.html) -[![build status](https://github.com/rust-num/num-bigint/workflows/master/badge.svg)](https://github.com/rust-num/num-bigint/actions) +[![build status](https://github.com/rust-num/num-bigint/actions/workflows/master.yaml/badge.svg)](https://github.com/rust-num/num-bigint/actions) Big integer types for Rust, `BigInt` and `BigUint`. @@ -18,8 +18,8 @@ num-bigint = "0.5" ## Features -The `std` crate feature is enabled by default, and is mandatory before Rust -1.36 and the stabilized `alloc` crate. If you depend on `num-bigint` with +The `std` crate feature is enabled by default, and is mandatory before Rust 1.36 +and the stabilized `alloc` crate. If you depend on `num-bigint` with `default-features = false`, you must manually enable the `std` feature yourself if your compiler is not new enough. @@ -48,18 +48,18 @@ The `num-bigint` crate is tested for rustc 1.60 and greater. ## Alternatives -While `num-bigint` strives for good performance in pure Rust code, other -crates may offer better performance with different trade-offs. The following -table offers a brief comparison to a few alternatives. +While `num-bigint` strives for good performance in pure Rust code, other crates +may offer better performance with different trade-offs. The following table +offers a brief comparison to a few alternatives. -| Crate | License | Min rustc | Implementation | Features | -| :--------------- | :---------------- | :-------- | :------------- | :------- | -| **`num-bigint`** | MIT OR Apache-2.0 | 1.60 | pure rust | dynamic width, number theoretical functions | -| [`awint`] | MIT OR Apache-2.0 | 1.70 | pure rust | fixed width, heap or stack, concatenation macros | -| [`bnum`] | MIT OR Apache-2.0 | 1.87 | pure rust | fixed width, parity with Rust primitives including floats | -| [`crypto-bigint`] | MIT OR Apache-2.0 | 1.85 | pure rust | fixed width, stack only | -| [`ibig`] | MIT OR Apache-2.0 | 1.49 | pure rust | dynamic width, number theoretical functions | -| [`rug`] | LGPL-3.0+ | 1.85 | bundles [GMP] via [`gmp-mpfr-sys`] | all the features of GMP, MPFR, and MPC | +| Crate | License | Min rustc | Implementation | Features | +| :--------------- | :---------------- | :-------- | :--------------------------------- | :-------------------------------------------------------- | +| **`num-bigint`** | MIT OR Apache-2.0 | 1.60 | pure Rust | dynamic width, number theoretical functions | +| [`awint`] | MIT OR Apache-2.0 | 1.70 | pure Rust | fixed width, heap or stack, concatenation macros | +| [`bnum`] | MIT OR Apache-2.0 | 1.87 | pure Rust | fixed width, parity with Rust primitives including floats | +| [`crypto-bigint`] | MIT OR Apache-2.0 | 1.85 | pure Rust | fixed width, stack only | +| [`ibig`] | MIT OR Apache-2.0 | 1.49 | pure Rust | dynamic width, number theoretical functions | +| [`rug`] | LGPL-3.0+ | 1.85 | bundles [GMP] via [`gmp-mpfr-sys`] | all the features of GMP, MPFR, and MPC | [`awint`]: https://crates.io/crates/awint [`bnum`]: https://crates.io/crates/bnum @@ -74,8 +74,8 @@ table offers a brief comparison to a few alternatives. Licensed under either of - * [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) - * [MIT license](http://opensource.org/licenses/MIT) + * [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0) + * [MIT license](https://opensource.org/license/mit) at your option.