From 068ba071abc6ff79bdffe2b7e65d31621eef78f1 Mon Sep 17 00:00:00 2001
From: zomo <ashleyzomo@gmail.com>
Date: Mon, 28 Jun 2021 20:13:42 -0500
Subject: [PATCH] init

---
 readme.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)

diff --git a/readme.md b/readme.md
index 1c76ada..905866f 100644
--- a/readme.md
+++ b/readme.md
@@ -1,3 +1,55 @@
 # types-ts-2take1
 
 Typescript types for 2take1, used with [typescripttolua](https://typescripttolua.github.io)
+
+## installing
+
+### downloading types
+
+`npm i -D git+https://git@git.zomo.dev/zomo/types-ts-2take1`
+
+### using types
+
+edit/create `tsconfig.json`
+
+```json
+{
+  "compilerOptions": {
+    "types": [
+        "types-ts-2take1"
+    ]
+  }
+}
+```
+
+## other recommended/optional settings
+
+### general compiling options
+
+`tsconfig.json`
+
+```json
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "lib": ["esnext"],
+    "moduleResolution": "node",
+    "strict": true,
+  }
+}
+```
+
+### issues compiling
+
+`tsconfig.json`
+
+```json
+{
+  "tstl": {
+    "luaTarget": "universal",
+    "luaLibImport": "inline",
+    "luaBundle": "main.lua",
+    "luaBundleEntry": "./path/to/main.ts",
+  }
+}
+```