readme

README.md

@@ -0,0 +1,20 @@
+## LiveViewJS Proof of Concept
+
+Learned about [Phoenix LiveView](https://hexdocs.pm/phoenix_live_view/Phoenix.LiveView.html) and really loved the concept.  Wanted to learn more about how it worked and see if I could get a basic PoC working in Typescript.
+
+### To Run
+`npm i` - install the deps
+
+`npm run server-build` - compile the server and watch for changes (tsc)
+
+`npm run client-build` - compiles the client code (parcel)
+
+`npm run server` - runs the server
+
+`npm run test` - runs the (few) tests
+
+### To see
+Point your browser to `http://localhost:3002/`
+
+### Where is the example page from?
+Watched the free version of this course: [Phoenix LiveView Course](https://pragmaticstudio.com/phoenix-liveview)