From 425decdf7e9284d15aa726e3ae96b9942fb0e3ea Mon Sep 17 00:00:00 2001
From: IronClawTrem <louie.nutman@gmail.com>
Date: Sun, 16 Feb 2020 03:40:06 +0000
Subject: create tremded branch

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

(limited to 'scripts/README.md')

diff --git a/scripts/README.md b/scripts/README.md
new file mode 100644
index 0000000..1da04b7
--- /dev/null
+++ b/scripts/README.md
@@ -0,0 +1,52 @@
+# Lua Scripts
+
+Scripts packaged with Tremulous. This folder will likely fill up with
+not so useful examples.
+
+Even more likely this will be the only source of documentation in the
+short term. Likely documentation will happen after the first large API
+re-organization.
+
+
+Available APIs 
+==============
+
+HTTP Client
+-----------
+   - `http.del()`
+   - `http.get()`
+   - `http.post()`
+   - `http.put()`
+
+   Returns a `HttpResponse` object.
+
+```lua
+   HttpResponse::code -- HTTP status code from server
+   HttpResponse::body -- Raw response body
+```
+
+### Example 
+```lua
+    print(http.get('www.google.com/search?q=' .. 'Hello World').body)
+```
+
+JSON
+----
+
+  - `rapidjson.encode()`
+  - `rapidjson.decode()`
+
+Cvar
+----
+
+  - `cvar.new(a, b, c)`
+  - `cvar.new(a, b)`
+  - `cvar.new(a)`
+
+Nettle
+------
+TBD
+
+Client
+------
+TBD
-- 
cgit