From 89f3d40a5cd960edebb9dea078fe33942a0bad84 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Hru=C5=A1ka?= Date: Tue, 9 Jun 2020 22:49:57 +0200 Subject: [PATCH] add readme --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..3271c96 --- /dev/null +++ b/README.md @@ -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.