diff options
| author | IronClawTrem <louie.nutman@gmail.com> | 2020-02-16 03:40:06 +0000 |
|---|---|---|
| committer | IronClawTrem <louie.nutman@gmail.com> | 2020-02-16 03:40:06 +0000 |
| commit | 425decdf7e9284d15aa726e3ae96b9942fb0e3ea (patch) | |
| tree | 6c0dd7edfefff1be7b9e75fe0b3a0a85fe1595f3 /scripts/README.md | |
| parent | ccb0b2e4d6674a7a00c9bf491f08fc73b6898c54 (diff) | |
create tremded branch
Diffstat (limited to 'scripts/README.md')
| -rw-r--r-- | scripts/README.md | 52 |
1 files changed, 52 insertions, 0 deletions
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
|