# Jsonata

 JSONata is a JSON query and transformation language.

 It can be very usefull for [ETL](https://en.wikipedia.org/wiki/Extract,_transform,_load) pipelines that have JSON as input and output.

 More info about JSONata can be found on their [website](https://jsonata.org/)
 
 
## Requirements

In addition to elixir this library requires the host machine to have [bun](https://bun.sh/) installed.

## Usage

JSONata is a very expressive language, in order to use this library you first have to learn it, a good place to start is [here](https://docs.jsonata.org/overview.html)

To evaluate a JSONata expression in your elixir project first add
jsonata to your dependencies.

```elixir
  {:jsonata, "~> 0.1.0"}
```

And then call the evaluate function

```elixir
  
  Jsonata.evaluate(template, data)
```

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed


Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at <https://hexdocs.pm/jsonata>.