Skip to content

Commit 6e12973

Browse files
authored
Update README.md
1 parent 2762434 commit 6e12973

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# JSON Rules
22

3-
The JSON Rules serves as an abstraction layer over the [Golang Rules Engine](https://github.com/nikunjy/rules/blob/master/README.md).
3+
JSON Rules is an abstraction layer over the [Golang Rules Engine](https://github.com/nikunjy/rules/blob/master/README.md).
44

5-
This packages allows you to represent rules in JSON format instead of using the original ANTLR query syntax from the nikunjy/rules implementation.
5+
This package allows you to represent rules in JSON format instead of using the original ANTLR query syntax from the nikunjy/rules implementation.
66

77
## Example Queries
88

@@ -35,9 +35,9 @@ The following operations are supported, matching those available in the [Golang
3535

3636
## JSON Rule Example
3737

38-
To create JSON rules, follow these steps:
38+
To create a JSON rule, follow these steps:
3939

40-
1. The `and` and `or`operation accepts a list of conditions. The and operation evaluates to true only if all conditions in the list are true, while the or operation evaluates to true if at least one condition is true. They are formatted as follows:
40+
1. The `and` and `or` operation accepts a list of conditions. The and operation evaluates to true only if all conditions in the list are true, while the or operation evaluates to true if at least one condition is true. They are formatted as follows:
4141

4242
```json
4343
{
@@ -67,7 +67,7 @@ To create JSON rules, follow these steps:
6767
```
6868

6969
## How to use
70-
This example demonstrates how to initialize the parser with a JSON rule and evaluate it against a set of data. Adjust the paths and data as necessary for your specific use case.
70+
This example demonstrates how to initialize the parser with a JSON rule and evaluate it against a data set. You can adjust the paths and data as necessary for your specific use case.
7171

7272
```Go
7373
p := parser.NewParser(filepath.Join("examples", "example.json"))

0 commit comments

Comments
 (0)