Add jsdoc, fix linter

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

diff --git a/README.md b/README.md
index c837b6d64b3e6bbeeabba97fcfc8b6eef3ff4485..b28114c0868e50e6f48dd4008a083902edfb602c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,3 +2,10 @@
 
 A renderer for the sorting hat, sorts you to a variety of sets based on the
 assignment of mind waves.
 
 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