From bacd66a442cace7d1f00486269c9a1bd8bd31db3 Mon Sep 17 00:00:00 2001 From: cloakedninjas Date: Wed, 9 Dec 2015 00:22:43 +0000 Subject: [PATCH] Adding readme --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c88c5aa --- /dev/null +++ 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. \ No newline at end of file