From 71b3d7e58170f63aeda5462c431a2d4fc681f12b Mon Sep 17 00:00:00 2001
From: TSnake41 <TSnake@Outlook.fr>
Date: Sun, 1 Mar 2020 13:58:16 +0100
Subject: [PATCH] Update README

---
 README.md      | 45 +++++++++++++++++++++++++++++++++++++++++++++
 src/raylua.lua |  2 ++
 2 files changed, 47 insertions(+)

diff --git a/README.md b/README.md
index 7d09729..933ba1e 100644
--- a/README.md
+++ b/README.md
@@ -56,6 +56,51 @@ If you need to update raylib binding, there are few tasks to do :
  - update `tools/api.h` functions signatures, keep file clean with exactly one function per line.
  - update struct definitions in `src/raylib.lua`
 
+### Loading embedded ressources
+
+Currently, raylib-lua doesn't support loading ressources from payload using
+raylib API. However, you can still arbitrarily load files from payload using
+`raylua.loadfile` which returns a boolean indicating success and file content.
+
+### Making structs
+
+To make raylib structs, you need to use the LuaJIT FFI.
+```lua
+local ffi = require "ffi"
+```
+
+Then use ffi.new to make a struct, e.g `ffi.new("Color", r, g, b, a)`
+
+#### Note concerning pointers
+
+As LuaJIT doesn't support pointer dereferencing, you need to build a
+single-element array, e.g
+```lua
+local image = ffi.new("Image[1]")
+```
+In this case, to access the element of `image`, you need to do `image[0]`.
+The pointer you can pass is `image`.
+
+### Example
+
+```lua
+rl.SetConfigFlags(rl.FLAG_VSYNC_HINT)
+rl.SetTargetFPS(60)
+
+rl.InitWindow(800, 450, "raylib [core] example - basic window")
+
+while not rl.WindowShouldClose() do
+	rl.BeginDrawing()
+
+	rl.ClearBackground(rl.RAYWHITE)
+	rl.DrawText("Congrats! You created your first window!", 190, 200, 20, rl.LIGHTGRAY)
+
+	rl.EndDrawing()
+end
+
+rl.CloseWindow()
+```
+
 ### Licence
 
 Copyright (C) 2020 Astie Teddy
diff --git a/src/raylua.lua b/src/raylua.lua
index b3f0df6..a29cac1 100644
--- a/src/raylua.lua
+++ b/src/raylua.lua
@@ -16,6 +16,8 @@
 
 local load = loadstring
 
+-- TODO: Embedded ressources loading.
+
 if raylua.loadfile then
   package.path = "?.lua"