Skip to content

Commit 27ed3fa

Browse files
committed
doc: note the new unstable feature
1 parent 04e2930 commit 27ed3fa

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,16 @@ assert!(!matches.matched(5));
188188
assert!(matches.matched(6));
189189
```
190190

191+
### Usage: enable SIMD optimizations
192+
193+
This crate provides an `unstable` feature that can only be enabled on nightly
194+
Rust. When this feature is enabled, the regex crate will use SIMD optimizations
195+
if your CPU supports them. No additional compile time flags are required; the
196+
regex crate will detect your CPU support at runtime.
197+
198+
When `std::arch` becomes stable, then these optimizations will be enabled
199+
automatically.
200+
191201

192202
### Usage: a regular expression parser
193203

0 commit comments

Comments
 (0)