Merge pull request #716 from atouchet/rdm

Update Readme

Author: Amanieu

README.md

@@ -1,20 +1,20 @@
-hashbrown
-=========
+# hashbrown
 
 [![Build Status](https://github.com/rust-lang/hashbrown/actions/workflows/rust.yml/badge.svg)](https://github.com/rust-lang/hashbrown/actions)
-[![Crates.io](https://img.shields.io/crates/v/hashbrown.svg)](https://crates.io/crates/hashbrown)
+[![crates.io](https://img.shields.io/crates/v/hashbrown.svg)](https://crates.io/crates/hashbrown)
 [![Documentation](https://docs.rs/hashbrown/badge.svg)](https://docs.rs/hashbrown)
 [![Rust](https://img.shields.io/badge/rust-1.85.0%2B-blue.svg?maxAge=3600)](https://github.com/rust-lang/hashbrown)
 
-This crate is a Rust port of Google's high-performance [SwissTable] hash
-map, adapted to make it a drop-in replacement for Rust's standard `HashMap`
-and `HashSet` types.
+This crate is a Rust port of Google's high-performance [SwissTable] hash map,
+adapted to make it a drop-in replacement for Rust's standard `HashMap` and
+`HashSet` types.
 
 The original C++ version of SwissTable can be found [here], and this
 [CppCon talk] gives an overview of how the algorithm works.
 
 Since Rust 1.36, the Rust standard library has adopted this implementation for
-`HashMap`, using its own default hasher (see [`std::hash::DefaultHasher`](https://doc.rust-lang.org/std/hash/struct.DefaultHasher.html)).
+`HashMap`, using its own default hasher (see
+[`std::hash::DefaultHasher`](https://doc.rust-lang.org/std/hash/struct.DefaultHasher.html)).
 However you may still want to use this crate instead since it works in
 environments without `std`, such as embedded systems and kernels.
 
@@ -27,11 +27,14 @@ environments without `std`, such as embedded systems and kernels.
 ## Features
 
 - Drop-in replacement for the standard library `HashMap` and `HashSet` types.
-- Uses [foldhash](https://github.com/orlp/foldhash) as the default hasher, which is much faster than SipHash.
-  However, foldhash does *not provide the same level of HashDoS resistance* as SipHash, so if that is important to you, you might want to consider using a different hasher.
+- Uses [foldhash](https://github.com/orlp/foldhash) as the default hasher, which
+  is much faster than SipHash. However, foldhash does *not provide the same
+  level of HashDoS resistance* as SipHash, so if that is important to you, you
+  might want to consider using a different hasher.
 - Around 2x faster than the previous standard library `HashMap`.
 - Lower memory usage: only 1 byte of overhead per entry instead of 8.
-- Compatible with `#[no_std]` (but requires a global allocator with the `alloc` crate).
+- Compatible with `#[no_std]` (but requires a global allocator with the `alloc`
+  crate).
 - Empty hash maps do not allocate any memory.
 - SIMD lookups to scan multiple hash entries in parallel.
 
@@ -41,7 +44,7 @@ Add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-hashbrown = "0.16"
+hashbrown = "0.17"
 ```
 
 Then:
@@ -54,29 +57,35 @@ map.insert(1, "one");
 ```
 
 ## Flags
+
 This crate has the following Cargo features:
 
 - `nightly`: Enables nightly-only features including: `#[may_dangle]`.
 - `serde`: Enables serde serialization support.
 - `rayon`: Enables rayon parallel iterator support.
-- `equivalent`: Allows comparisons to be customized with the `Equivalent` trait. (enabled by default)
+- `equivalent`: Allows comparisons to be customized with the `Equivalent` trait.
+  (enabled by default)
 - `raw-entry`: Enables access to the deprecated `RawEntry` API.
-- `inline-more`: Adds inline hints to most functions, improving run-time performance at the cost
-  of compilation time. (enabled by default)
-- `default-hasher`: Compiles with foldhash as default hasher. (enabled by default)
-- `allocator-api2`: Enables support for allocators that support `allocator-api2`. (enabled by default)
+- `inline-more`: Adds inline hints to most functions, improving run-time
+  performance at the cost of compilation time. (enabled by default)
+- `default-hasher`: Compiles with foldhash as default hasher. (enabled by
+  default)
+- `allocator-api2`: Enables support for allocators that support
+  `allocator-api2`. (enabled by default)
 
 ## License
 
 Licensed under either of:
 
- * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0)
- * MIT license ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT)
+ * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
+   https://www.apache.org/licenses/LICENSE-2.0)
+ * MIT license ([LICENSE-MIT](LICENSE-MIT) or
+   https://opensource.org/license/mit)
 
 at your option.
 
 ### Contribution
 
 Unless you explicitly state otherwise, any contribution intentionally submitted
-for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
-additional terms or conditions.
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
+dual licensed as above, without any additional terms or conditions.