Merge branch 'release/1.0.0'

[rbdr/sorting-hat-renderer] / README.md

diff --git a/README.md b/README.md
index b48ac8c097dbc2624ed4313367250a4b0fd205ba..b28114c0868e50e6f48dd4008a083902edfb602c 100644 (file)
--- 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