release 1.3.0

Author: srijs

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "crc32fast"
-version = "1.2.2"
+version = "1.3.0"
 license = "MIT OR Apache-2.0"
 authors = [
   "Sam Rijs <[email protected]>",

README.md

@@ -1,19 +1,31 @@
 # crc32fast [![Build Status][travis-img]][travis] [![Crates.io][crates-img]][crates] [![Documentation][docs-img]][docs]
 
-[travis-img]:   https://travis-ci.com/srijs/rust-crc32fast.svg?branch=master
-[travis]:       https://travis-ci.com/srijs/rust-crc32fast
-[crates-img]:   https://img.shields.io/crates/v/crc32fast.svg
-[crates]:       https://crates.io/crates/crc32fast
-[docs-img]:     https://docs.rs/crc32fast/badge.svg
-[docs]:         https://docs.rs/crc32fast
+[travis-img]: https://travis-ci.com/srijs/rust-crc32fast.svg?branch=master
+[travis]: https://travis-ci.com/srijs/rust-crc32fast
+[crates-img]: https://img.shields.io/crates/v/crc32fast.svg
+[crates]: https://crates.io/crates/crc32fast
+[docs-img]: https://docs.rs/crc32fast/badge.svg
+[docs]: https://docs.rs/crc32fast
 
 _Fast, SIMD-accelerated CRC32 (IEEE) checksum computation_
 
 ## Usage
 
+### Simple usage
+
+For simple use-cases, you can call the `hash` convenience function to
+directly compute the CRC32 checksum for a given byte slice:
+
 ```rust
-extern crate crc32fast;
+let checksum = crc32fast::hash(b"foo bar baz");
+```
 
+### Advanced usage
+
+For use-cases that require more flexibility or performance, for example when
+processing large amounts of data, you can create and manipulate a `Hasher`:
+
+```rust
 use crc32fast::Hasher;
 
 let mut hasher = Hasher::new();
@@ -33,10 +45,10 @@ Calling the `Hasher::new` constructor at runtime will perform a feature detectio
 optimal implementation for the current CPU feature set.
 
 | crate                               | version | variant   | ns/iter | MB/s |
-|-------------------------------------|---------|-----------|---------|------|
-| [crc](https://crates.io/crates/crc) | 1.8.1   | n/a       |   4,926 |  207 |
-| crc32fast (this crate)              | 1.0.0   | baseline  |     683 | 1499 |
-| crc32fast (this crate)              | 1.0.0   | pclmulqdq |     140 | 7314 |
+| ----------------------------------- | ------- | --------- | ------- | ---- |
+| [crc](https://crates.io/crates/crc) | 1.8.1   | n/a       | 4,926   | 207  |
+| crc32fast (this crate)              | 1.0.0   | baseline  | 683     | 1499 |
+| crc32fast (this crate)              | 1.0.0   | pclmulqdq | 140     | 7314 |
 
 ## Memory Safety
 
@@ -67,10 +79,10 @@ Currently, enabling this feature flag will make the optimized `aarch64` implemen
 
 This project is licensed under either of
 
- * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
-   http://www.apache.org/licenses/LICENSE-2.0)
- * MIT license ([LICENSE-MIT](LICENSE-MIT) or
-   http://opensource.org/licenses/MIT)
+- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
+  http://www.apache.org/licenses/LICENSE-2.0)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or
+  http://opensource.org/licenses/MIT)
 
 at your option.