Updated readme.md

This commit is contained in:
Martin Donnelly 2024-05-08 15:11:38 +01:00
parent 149ae4e688
commit fa57b2d36e

View File

@ -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". 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 options are specified in JSON contained within the `src/app/app.component.ts` file.
The JSON is structured as an array of SearchFragments: The JSON is structured as an array of SearchFragments:
@ -12,35 +24,35 @@ The JSON is structured as an array of SearchFragments:
```json ```json
[ [
{ {
"mode" : { "mode" : {
"title" : "Project", "title" : "Project",
"accepted" : ".+", "accepted" : ".+",
"output" : "Project title {{$modifier}} {{$value}}", "output" : "Project title {{$modifier}} {{$value}}",
"hint" : "Project title" "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"
}
]
}, },
"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"
}
]
},
] ]