From fa57b2d36e2b599c0b0a44e140d7a914053f2ad5 Mon Sep 17 00:00:00 2001 From: Martin Donnelly Date: Wed, 8 May 2024 15:11:38 +0100 Subject: [PATCH] Updated readme.md --- README.md | 68 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 40 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 7cde99a..aa4ca89 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,18 @@ I have created a small test harness for a basic Omni Search box, it is not complete as it's a simple test harness to get the concept essentiall "down on paper". +**To Run** + +```bash + + $ npm run start + +``` + +It should be available in the browser at `http://localhost:4200/` + +--- + The options are specified in JSON contained within the `src/app/app.component.ts` file. The JSON is structured as an array of SearchFragments: @@ -12,35 +24,35 @@ The JSON is structured as an array of SearchFragments: ```json [ - { - "mode" : { - "title" : "Project", - "accepted" : ".+", - "output" : "Project title {{$modifier}} {{$value}}", - "hint" : "Project title" - }, - "modifiers" : [ - { - "title" : "Is", - "accepted" : "is", - "output" : "IS", - "hint" : "Is Operator" - }, - { - "title" : "Isn't", - "accepted" : "isn't", - "output" : "IS NOT", - "hint" : "Is Not Operator" - }, - { - "title" : "Contains", - "accepted" : "contains", - "output" : "CONTAINS", - "hint" : "Contains Operator" - } - ] - + { + "mode" : { + "title" : "Project", + "accepted" : ".+", + "output" : "Project title {{$modifier}} {{$value}}", + "hint" : "Project title" }, + "modifiers" : [ + { + "title" : "Is", + "accepted" : "is", + "output" : "IS", + "hint" : "Is Operator" + }, + { + "title" : "Isn't", + "accepted" : "isn't", + "output" : "IS NOT", + "hint" : "Is Not Operator" + }, + { + "title" : "Contains", + "accepted" : "contains", + "output" : "CONTAINS", + "hint" : "Contains Operator" + } + ] + + }, ]