From 9fce0a2be362a2cbd5d78b1ab5b0c13d6f47e89a Mon Sep 17 00:00:00 2001
From: Jakob Odersky <jakob@odersky.com>
Date: Mon, 14 Nov 2016 14:32:13 -0800
Subject: More docs and style

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..09493f6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+A simple chat application that demonstrates integration of Play with ScalaJS.
+
+## Run
+
+1. start sbt: `sbt`
+2. compile on demand, when files change: `run`
+3. go to `http://localhost:9000/chat/USERNAME` where `USERNAME` is your name of choice
+
+## Important directories
+
+- `server/` contains the Play server that will serve the client app
+- `client/` ScalaJS client app sources
+- `shared/` common sources, available in both server and client. In this project, shared contains messages that are passed between the server and client via a websocket
+
+## References
+- [Play framework](https://www.playframework.com)
+- [ScalaJS](https://www.scala-js.org/)
+- [Play-ScalaJS integration](https://github.com/vmunier/play-with-scalajs-example)
-- 
cgit v1.2.3