Skip to content

Commit 5cef4fc

Browse files
committed
Update README
1 parent 8a494c3 commit 5cef4fc

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@ You'll need to adjust if you want to optimize with [feature flags](Cargo.toml).
4444

4545
## Usage
4646

47+
Add `crc-fast = { version = "1.2", features = ["optimize_crc32_auto"] }` to your `Cargo.toml` dependencies, which will
48+
enable every available optimization for the `stable` toolchain. Adjust as necessary for your desired
49+
[acceleration targets](#acceleration-targets).
50+
4751
### Digest
4852

4953
Implements the [digest::DynDigest](https://docs.rs/digest/latest/digest/trait.DynDigest.html)
@@ -155,7 +159,7 @@ variant, and all of them were "reflected" variants.
155159
In contrast, this library accelerates _every known variant_ (and should accelerate any future variants without changes),
156160
including all the "non-reflected" variants.
157161

158-
## Important variants
162+
## Important CRC variants
159163

160164
While there are [many variants](https://reveng.sourceforge.io/crc-catalogue/all.htm#crc.cat.crc-32-iso-hdlc), three
161165
stand out as being the most important and widely used (all of which are "reflected"):

0 commit comments

Comments
 (0)