From ce846e8386dc52ab33aa68ba0b2f4351479904c2 Mon Sep 17 00:00:00 2001
From: Jacob Stannix <jakestannix@gmail.com>
Date: Thu, 22 Aug 2024 12:03:45 -0600
Subject: [PATCH] updated README.md

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/README.md b/README.md
index 34525e5..535157e 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,34 @@
 # Lua 
 ## 5.4.7
+
+To build all targets run 
+```sh
+zig build
+```
+
+## Build Artifacts
+| Name | Artifact |
+| "lua" | The main lua library |
+| "lua_exe" | The lua interpreter |
+| "luac" | The lua bytecode compiler |
+
+## Compile Options
+| Name | Type | Description |
+| release | bool | optimize for end users |
+| shared | bool | build as shared library |
+| use_readline | bool | readline support for linux |
+
+## Using in a zig project
+To add to a zig project run:
+```
+```
+then add the following to your `build.zig` 
+```zig
+const lua_dep = b.dependency("lua", .{
+    .{
+        .target = target,
+        .release = optimize != .Debug,
+    }
+});
+const lua_lib = lua_dep.artifact("lua");
+```