Merge pull request #1 from nordnet/docs/improvements

Docs/improvements WIP

README.md

@@ -13,14 +13,12 @@ Features:
 * Trustworthy README with Install, Usage, Api and License sections
 * [Easy testability, `tdd` mode][tdd] and test coverage
 * [Ready to use with travis and coveralls](#next-steps)
-* Support for package.json’s fields, your github username too
-* Memorizing fields: your name, email, website and github username and license
 * And obviously ![Badges][badges] for npm, tests, coverage and dependencies
 
 [tdd]: https://iamstarkov.com/start-with-testing/
 [badges]: https://img.shields.io/badge/with-badges-brightgreen.svg?style=flat-square
 
-![soylent example](http://i.imgur.com/10C4sIn.png)
+![transparent-banking example](https://i.imgur.com/CUXqF1W.png)
 
 ## Install
 
@@ -29,8 +27,8 @@ Features:
 ## Usage
 
     # create folder for your project
-    mkdir awsm-project
-    cd awsm-project
+    mkdir transparent-banking
+    cd transparent-banking
 
     # run generator
     yo nordnet-es-module
@@ -39,7 +37,6 @@ Features:
     git init
     git commit -am 'init commit'
 
-
 ### Next steps:
 
 1. Push it to your github repo

app/templates/_README.md

@@ -1,5 +1,10 @@
 # <%= moduleName %>
 
+[![NPM version][npm-image]][npm-url]
+[![Build Status][travis-image]][travis-url]
+[![Coveralls Status][coveralls-image]][coveralls-url]
+[![Dependency Status][depstat-image]][depstat-url]
+
 > <%= moduleDesc %>
 
 ## Install
@@ -11,7 +16,7 @@
 ```js
 import <%= camelModuleName %> from '<%= moduleName %>';
 
-<%= camelModuleName %>('unicorns'); // unicorns
+<%= camelModuleName %>('transparent banking'); // transparent banking
 ```
 
 ## API
@@ -33,3 +38,19 @@ Type: `Boolean`
 Default: `false`
 
 Lorem ipsum.
+
+## License
+
+MIT © [Nordnet Bank AB](https://www.nordnet.se/)
+
+[npm-url]: https://npmjs.org/package/<%= moduleName %>
+[npm-image]: https://img.shields.io/npm/v/<%= moduleName %>.svg?style=flat-square
+
+[travis-url]: https://travis-ci.org/nordnet/<%= moduleName %>
+[travis-image]: https://img.shields.io/travis/nordnet/<%= moduleName %>.svg?style=flat-square
+
+[coveralls-url]: https://coveralls.io/r/nordnet/<%= moduleName %>
+[coveralls-image]: https://img.shields.io/coveralls/nordnet/<%= moduleName %>.svg?style=flat-square
+
+[depstat-url]: https://david-dm.org/nordnet/<%= moduleName %>
+[depstat-image]: https://david-dm.org/nordnet/<%= moduleName %>.svg?style=flat-square

test.js

@@ -38,10 +38,7 @@ describe('generator', function () {
 
     helpers.mockPrompt(this.generator, {
       moduleName: 'module',
-      pipe: 'dl',
-      moduleDesc: 'Your awsm module!',
-      publishConfig: 'https://abc.com',
-      repositoryUrl: 'https://github.com/username/repo.git',
+      moduleDesc: 'Your awsm module!'
     });
 
     this.generator.run(function () {