aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index e69de29..34d58c3 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,7 @@
+# ywot-clean
+
+A reconstructed version of `ywot-bot` built off of clean programming principles and a minimal, but fast API.
+
+# Features
+
+Currently, `socket.js` provides `Socket` which has a few signals and functions (documented in the code, of course) which allow abstracted interfacing with YWOT. However, certain facilities available in the old version like queuing or fetch division were scrapped in favor of more direct limits due to the unmaintainability of the old style.