Skip to content

Commit

Permalink
Added About heading and Code of Conduct note in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mherwig authored Feb 6, 2024
1 parent dc7dd3d commit 6333aac
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,24 @@ SPDX-License-Identifier: CC0-1.0
[![REUSE status](https://api.reuse.software/badge/github.com/telekom/JSON-Filter)](https://api.reuse.software/info/github.com/telekom/JSON-Filter)
[![Issues](https://img.shields.io/github/issues/telekom/JSON-Filter?style=flat)](https://github.com/telekom/JSON-Filter/issues)

## About

JSON filter is a small, lightweight filter-library that allows to evaluate JSON payload against a filter consisting of
operators.
Operators can be defined programmatically or in JSON- or YAML-files.
The evaluation of JSON payloads against a filter results in an EvaluationResult, which indicates why a filter failed.

## Code of Conduct

This project has adopted the [Contributor Covenant](https://www.contributor-covenant.org/) in version 2.1 as our code of conduct. Please see the details in our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). All contributors must abide by the code of conduct.

By participating in this project, you agree to abide by its [Code of Conduct](./CODE_OF_CONDUCT.md) at all times.

## Licensing

This project follows the [REUSE standard for software licensing](https://reuse.software/).
Each file contains copyright and license information, and license texts can be found in the [./LICENSES](./LICENSES) folder. For more information visit https://reuse.software/.

## Usage

There are two types of operators: comparison- and logical-operators.
Expand Down Expand Up @@ -167,8 +180,3 @@ The result of the evaluation is an `EvaluationResult` that indicates if and why
| in | `in` | comparison | Valid if `field` is in `value`. |
| contains | `ct` | comparison | Valid if `field` contains `value`. |
| nct | `nct` | comparison | Valid if `field` does not contain `value`. |

## Licensing

This project follows the [REUSE standard for software licensing](https://reuse.software/).
Each file contains copyright and license information, and license texts can be found in the [./LICENSES](./LICENSES) folder. For more information visit https://reuse.software/.

0 comments on commit 6333aac

Please sign in to comment.