work on #31: fancier README

README.md

@@ -1,52 +1,73 @@
 # generator-m
 
-[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage Status][coveralls-image]][coveralls-url]
+[![NPM version](http://img.shields.io/npm/v/generator-m.svg?style=flat-square)][npm-url] 
+[![Coverage Status](http://img.shields.io/coveralls/mwaylabs/generator-m.svg?style=flat-square)][coveralls-url] 
+[![Build Status](https://img.shields.io/travis/mwaylabs/generator-m.svg?style=flat-square)][travis-url] 
+[![Dependency Status](http://img.shields.io/david/mwaylabs/generator-m.svg?style=flat-square)][daviddm-url]
+[![Download Month](http://img.shields.io/npm/dm/generator-m.svg?style=flat-square)][npm-url]
 
-[npm-image]: https://badge.fury.io/js/generator-m.svg
 [npm-url]: https://npmjs.org/package/generator-m
-[travis-image]: https://travis-ci.org/mwaylabs/generator-m.svg?branch=master
+[coveralls-url]: https://coveralls.io/r/mwaylabs/generator-m?branch=master
 [travis-url]: https://travis-ci.org/mwaylabs/generator-m
-[daviddm-image]: https://david-dm.org/mwaylabs/generator-m.svg?theme=shields.io
 [daviddm-url]: https://david-dm.org/mwaylabs/generator-m
-[coveralls-image]: https://coveralls.io/repos/mwaylabs/generator-m/badge.png?branch=master
-[coveralls-url]: https://coveralls.io/r/mwaylabs/generwator-m?branch=master
+
 
 ## Why you need it
 Build mobile Cordova/PhoneGap apps quickly with the tools you love:
 Yeoman, Gulp, Bower, AngularJS, Ionic & of course Cordova all in one sexy generator.
 
-## What's in the box
-Your technology stack:
+### What's in the box
+
+<p align="center">
+  <a href="http://yeoman.io/">
+    <img height="100" src="https://cloud.githubusercontent.com/assets/1370779/6041228/c1f91cac-ac7a-11e4-9c85-1a5298e29067.png">
+  </a>
+  <a href="http://gulpjs.com/">
+    <img height="100" src="https://cloud.githubusercontent.com/assets/1370779/6041282/34b4a914-ac7b-11e4-8f24-86795ccf49df.png">
+  </a>
+  <a href="http://bower.io/">
+    <img height="100" src="https://cloud.githubusercontent.com/assets/1370779/6041250/ef9a78b8-ac7a-11e4-9586-7e7e894e201e.png">
+  </a>
+  <a href="https://angularjs.org/">
+    <img height="100" src="https://cloud.githubusercontent.com/assets/1370779/6041199/5978cb96-ac7a-11e4-9568-829e2ea4312f.png">
+  </a>
+  <a href="http://ionicframework.com/">
+    <img height="100" src="https://cloud.githubusercontent.com/assets/1370779/6041296/59c5717a-ac7b-11e4-9d5d-9c5232aace64.png">
+  </a>
+  <a href="http://cordova.apache.org/">
+    <img height="100" src="https://cloud.githubusercontent.com/assets/1370779/6041269/20ed1196-ac7b-11e4-8707-68fa331f1aeb.png">
+  </a>
+</p>
+We use:
+
+- **yeoman** to scaffold your app - http://yeoman.io/
+- **gulp** to run your tasks - http://gulpjs.com/
+- **bower** to manage your client packages - http://bower.io/
+
+
+Working nicely with the following technology stack:
 
 - **angular** - https://angularjs.org/
   - **angular-ui-router** - https://github.com/angular-ui/ui-router
 - **ionic** - http://ionicframework.com/
   - **ngCordova** - http://ngcordova.com/
 - **Cordova** - http://cordova.apache.org/
 
-Additionally we use:
-
-- **yeoman** to scaffold your app - http://yeoman.io/
-- **gulp** to run your tasks - http://gulpjs.com/
-- **bower** to manage your client packages - http://bower.io/
-
-## Prerequisites
+## Install
+```
+npm install -g generator-m
+```
+### Prerequisites
 - node `>= 0.10.0` & npm ` >= 1.4.3` - http://nodejs.org/download/
   - yo: `npm install -g yo` - http://yeoman.io/
   - gulp: `npm install -g gulp` - http://gulpjs.com/
   - bower: `npm install -g bower` - http://bower.io/
 - Ruby/Sass
   - ruby - https://www.ruby-lang.org/en/installation/
   - sass - http://sass-lang.com/install
-- SDKs depending on selected platforms
+- SDKs depending the platforms you want to use
   - Cordova 4.0 Platform Guides - http://cordova.apache.org/docs/en/4.0.0/guide_platforms_index.md.html#Platform%20Guides
 
-
-## Install
-```
-npm install -g generator-m
-```
-
 ## Usage
 **create new directory** - and cd into it. Note: the generator needs an empty directory when you call it
 ```
@@ -58,7 +79,7 @@ yo m
 ```
 IMPORTANT: Cordova needs an empty directory to work. Please run any other setup (e.g. `git init`) after running `yo m`.
 
-## Commands
+### Commands
 **gulp watch** or **gulp** - prepares everything for development. Get ready to start coding!
 
 ```
@@ -89,8 +110,8 @@ Livereloads your application when changing/adding/deleting files to immediately
   gulp config --setVersion=1.1.0 --setBuild=12 --setBundle=com.new.bundle
 ```
 
-## sub-generators
-### yo m:module - creates a new module
+### sub-generators
+#### yo m:module - creates a new module
 1. `yo m:module <name>` - create a new module
 2. add your module to the `app/app.js`:
 
@@ -107,20 +128,20 @@ Livereloads your application when changing/adding/deleting files to immediately
 4. **Done!** - see your new module in action!
 
 
-### yo m:others
+#### yo m:others
 ```
   yo m:controller <name> <module>(optional - defaults to main)
   yo m:template <name> <module>(optional - defaults to main)
   yo m:service <name> <module>(optional - defaults to main)
 ```
 
-## Troubleshooting
+### Troubleshooting
 If you're experiencing difficulties using the generator please refer to the [Troubleshooting](https://github.com/mwaylabs/generator-m/wiki/Troubleshooting) section in our wiki!
 
-## Continuous Integration
+### Continuous Integration
 For now we provide a rudimentary `jenkins.sh` template that can be configured to build your projects with jenkins.
 
-## Options
+### Options
 ```
 yo m --skip-sdk # skip adding cordova platforms and plugins (sdk-specific) for travis
 yo m --appName='App Name' # set appName via CLI
@@ -137,5 +158,5 @@ Start by reading our:
 1. [Contribution Guide](https://github.com/mwaylabs/generator-m/wiki/Contribution-Guide)
 
 
-### License
+## License
 Code licensed under MIT. Docs under Apache 2. PhoneGap is a trademark of Adobe.