aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/hyperscan/README.md
blob: cc3ff7990e558f24e11a2bf3c17abb99e6960673 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# Hyperscan 
 
Hyperscan is a high-performance multiple regex matching library. It follows the 
regular expression syntax of the commonly-used libpcre library, but is a 
standalone library with its own C API. 
 
Hyperscan uses hybrid automata techniques to allow simultaneous matching of 
large numbers (up to tens of thousands) of regular expressions and for the 
matching of regular expressions across streams of data. 
 
Hyperscan is typically used in a DPI library stack. 
 
# Documentation 
 
Information on building the Hyperscan library and using its API is available in 
the [Developer Reference Guide](http://intel.github.io/hyperscan/dev-reference/).
 
# License 
 
Hyperscan is licensed under the BSD License. See the LICENSE file in the 
project repository. 
 
# Versioning 
 
The `master` branch on Github will always contain the most recent release of 
Hyperscan. Each version released to `master` goes through QA and testing before 
it is released; if you're a user, rather than a developer, this is the version 
you should be using. 
 
Further development towards the next release takes place on the `develop` 
branch. 
 
# Get Involved 
 
The official homepage for Hyperscan is at [www.hyperscan.io](https://www.hyperscan.io).
 
If you have questions or comments, we encourage you to [join the mailing 
list](https://lists.01.org/mailman/listinfo/hyperscan). Bugs can be filed by 
sending email to the list, or by creating an issue on Github. 
 
If you wish to contact the Hyperscan team at Intel directly, without posting 
publicly to the mailing list, send email to 
[hyperscan@intel.com](mailto:hyperscan@intel.com).