README.md

# Pathfinder

jsonpath in elixir through nodejs

made possible thanks to reverly'

⚠️WIP. This is an early and uncomplete release, expect breaking changes

## Installation

### Prerequisite
- Installation of nodejs

### Steps
1. Add pathfinder to your mix.exs
```elixir
def deps do
  [
    {:pathfinder, "~> 0.1.0"}
  ]
end
```
1. Run `mix deps.get`
1. Copy files
`cp ../deps/pathfinder/node ./`
1. Install NodeJS dependencies
`cd node && npm install`

## API

```

```
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/pathfinder](https://hexdocs.pm/pathfinder).

## Dev status

[x] .query/2
[ ] .paths
[ ] .nodes
[ ] .parse
[ ] .parent
[ ] .value
[ ] .stringify