aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBen Beltran <ben@nsovocal.com>2017-08-30 00:29:19 -0500
committerBen Beltran <ben@nsovocal.com>2017-08-30 00:29:19 -0500
commitb78f678de4f242b2a364bbf0cc39c8ec61ee5357 (patch)
tree92cb79b266ec9b5b609a8e8ba829bda3d7315ca8 /README.md
parentdc7f608a828fc0b34a291af915727ab1f7d6ba0a (diff)
parent21f11b5ae525f52fd1a2bf1a741ad79bfccb1278 (diff)
Merge branch 'release/1.0.0'HEADmain
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