Add README

InsanityRadio · Apr 27, 2017 · 32c9e12 · 32c9e12
1 parent cc83e26
commit 32c9e12
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,15 @@
+# <img src="https://raw.githubusercontent.com/InsanityRadio/OnAirController/master/doc/headphones_dark.png" align="left" height=48 /> Web Player
+
+This is a Cordova-based application for playing an Icecast stream. 
+
+Specifically, Cordova-TypeScript-WebPack.
+
+## Modifying
+
+At some point all the configuration options will be moved to a single file. Until this is the case, you have to go diving for the stream URL etc.
+
+## Installation
+
+Firstly, `npm install` to install all the node modules you need.
+
+Run `webpack`. Then copy the `www` directory to your web server.