From bf7eaa088c5e42f01778dddfe225ca6f3124ed2f Mon Sep 17 00:00:00 2001 From: Edward Hope-Morley Date: Fri, 16 Aug 2024 09:26:59 +0100 Subject: [PATCH] Update README --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2dd4349..2ff21d8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Searchkit -Python library providing tools to search files in parallel. +Python library providing file search tools. + +The basic principle of searchkit is that you add one or more file or path and then register one or more search against those paths. Searches are executed in parallel and different types are supported such as simple one line search or multiline/sequence search. Constraints can optionally be applied to searches. ## Search Types