add readme

2020-06-09 22:49:57 +02:00
parent 50a26664e3
commit 89f3d40a5c
1 changed files with 13 additions and 0 deletions
@@ -0,0 +1,13 @@
+# prefix_match
+
+Abbreviated multi-part command / word sequence recognition.
+
+Supports partial match (only some command words), individual multi-part command word abbreviating,
+as well as (obviously) simple single-word commands and their abbreviations.
+
+Can recognize things like `"ip i s d"` as `"ip interface set down"` or `"r a"` as `"route add"`,
+if there is no ambiguity among the provided options. Supports more than one delimiter at a time 
+(e.g, colon, hyphen, underscore, space, tab, whatever). Leading and trailing delimiters and
+duplicate delimiters are ignored.
+
+Inspect the unit test suite and doc comments in the header file for more info and examples of use.