From 670c628fc066c7c59e69d7ffe33f80781d96a74c Mon Sep 17 00:00:00 2001
From: connorwalsh <c@polygon.pizza>
Date: Sat, 28 Apr 2018 11:19:12 -0400
Subject: [PATCH] [cw|#6] quickly document on `xaqt` library on a high level

Notes:
* create godoc during this refactor and remove `docs.md`
---
 docs.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 docs.md

diff --git a/docs.md b/docs.md
new file mode 100644
index 0000000..8525ea6
--- /dev/null
+++ b/docs.md
@@ -0,0 +1,16 @@
+# XAQT Library
+*TODO (cw|4.28.2018) create godocs instead of this file...these are mostly notes for myself during development.*
+
+# Public Types
+* **`xaqt.Context`**: entrypoint into all functionality. TODO Propose renaming?
+* **`xaqt.Compilers`**: list of compilters. Propose re-typing to `[]Compiler`.
+* **`xaqt.Message`**: details on success or failure of execution
+
+# Public Methods
+
+``` go
+func NewContext(xaqt.Compilers, ...option) // option should be public!
+func (ctx *Context) ReadCompilers(string)
+func (ctw *Context) Languages([]string) // rename -> GetSupportedLanguages ?
+func (ctw *Context) Evaluate(string, string, []string)
+```