bp/Lua/README.md

# Lua Bindings

This directory contains Lua bindings for bp. The bindings are intended to be roughly
equivalent in usefulness to LPEG, but with a smaller codebase.

## API

```lua
local bp = require("bp")
local m, i, len = bp.match("like finding a needle in a haystack", '"n" @Es=+`e "dle"')
--> {[0]="needle", Es={[0]="ee"}}
--> tostring(m) == "needle", tostring(m.Es) == "ee"
local replaced = bp.match("like finding a needle in a haystack", '"n" +`e "dle"', "cat")
--> "like finding a cat in a haystack"
```