aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README18
1 files changed, 18 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..e65fa24
--- /dev/null
+++ b/README
@@ -0,0 +1,18 @@
+NAME
+ libautomata - Stateful automata based string matching
+
+SYNOPSIS
+ #include <libautomata.h>
+
+ Link with -lautomata.
+
+DESCRIPTION
+ libautomata provides function for creating, string
+ matching automata that can be feed in chunks, allowing
+ online processing of massive data sets. The automata
+ are resetable and clonable, allowing the user to search
+ multiple data sets but only run the automata building
+ phase once.
+
+SEE ALSO
+ None.