aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/README.md b/README.md
index b48ac8c..b28114c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,11 @@
-# sorting-hat-renderer
-Frontend for the sorting hat
+# Sorting Hat Frontend
+
+A renderer for the sorting hat, sorts you to a variety of sets based on the
+assignment of mind waves.
+
+## Building
+
+`npm run build`
+
+You can then serve the project statically. As of this version it expects
+a websocket server in port 1987