docs(README.md): example

1 files changed, 23 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bb2445b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Divina
+
+A modern build system for assembly
+
+```lua
+-- Divina.lua
+
+Package = {
+  name = "example",
+  version = "0.1.0",
+  description = "A default Divina package that you can extend!",
+  compile_options = {},
+  minimum_divina_version = Divina.version,
+  sources = {
+    "example/Main.asm",
+  },
+  type = Divina.Type.Bin,
+  arch = Divina.Arch.x64,
+  license = "Unlicense",
+}
+
+return Package
+```