aboutsummaryrefslogtreecommitdiff
path: root/Lua/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Lua/README.md')
-rw-r--r--Lua/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/Lua/README.md b/Lua/README.md
new file mode 100644
index 0000000..dfc10bf
--- /dev/null
+++ b/Lua/README.md
@@ -0,0 +1,11 @@
+# Lua Bindings
+
+This directory contains Lua bindings for bp.
+
+## API
+
+```lua
+local bp = require("bp")
+local m, i, len = bp.match("like finding a needle in a haystack", '"n" +`e "dle"')
+local replaced = bp.match("like finding a needle in a haystack", '"n" +`e "dle"', "cat")
+```