1 files changed, 20 insertions, 0 deletions
diff --git a/native/treebitmap_nif/README.md b/native/treebitmap_nif/README.md
new file mode 100644
index 0000000..67e961c
--- /dev/null
+++ b/native/treebitmap_nif/README.md
@@ -0,0 +1,20 @@
+# NIF for Elixir.TreeBitmap.NIF
+
+## To build the NIF module:
+
+- Your NIF will now build along with your project.
+
+## To load the NIF:
+
+```elixir
+defmodule TreeBitmap.NIF do
+    use Rustler, otp_app: :tree_bitmap, crate: "treebitmap_nif"
+
+    # When your NIF is loaded, it will override this function.
+    def add(_a, _b), do: :erlang.nif_error(:nif_not_loaded)
+end
+```
+
+## Examples
+
+[This](https://github.com/hansihe/NifIo) is a complete example of a NIF written in Rust.