Adding readme

cloakedninjas · Dec 9, 2015 · bacd66a · bacd66a
1 parent 7856f49
commit bacd66a
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,28 @@
+# Phaser Typescript Boilerplate
+
+Unopinionated (mostly) package containing bare bones Phaser game, containing:
+
+* Phaser (2.4.4)
+* Game
+  * Preload State
+  * Game State
+* Grunt build process
+
+## Installing
+
+`bower install phaser-typescript-boilerplate`
+
+Or clone from Git:
+
+`git clone https://github.com/cloakedninjas/phaser-typescript-boilerplate.git`
+
+Then install dependencies:
+
+```
+npm install;
+bower install;
+```
+
+## Building
+
+`grunt dev` for single build or `grunt watch` to compile as you make changes.