From 5cec436f60cf4ef47b71dd308f3c943c722f7a3f Mon Sep 17 00:00:00 2001
From: Rokas Puzonas <rokas.puz@gmail.com>
Date: Thu, 11 May 2023 20:54:59 +0300
Subject: [PATCH] add readme

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..63ee82f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+# TIC80 LSP function definitions
+
+Lua function definitions for [TIC80](https://tic80.com/) functions.
+It generates a addon which [lua-language-serve](https://github.com/LuaLS/lua-language-server) can understand.
+The generator script works by scraping github wiki page for tic80 https://github.com/nesbox/TIC-80/wiki.
+
+There is a tutorial [here](https://github.com/LuaLS/lua-language-server/wiki/Addons) where it explains how
+to use addons made for the lua language server.