Merge pull request #17 from robertoachar/develop

v2.2.1

CHANGELOG.md

@@ -1,89 +1,96 @@
 # Changelog
 
+## v2.2.1
+
+### Generator Updates
+
+- **build**: update jest
+- **docs**: update README
+
 ## v2.2.0
 
 ### Template Updates
 
-* **ci**: update circleci node version
-* **ci**: update circleci to v2
-* **docs**: update README
-* **refactor**: update .gitignore
+- **ci**: update circleci node version
+- **ci**: update circleci to v2
+- **docs**: update README
+- **refactor**: update .gitignore
 
 ### Generator Updates
 
-* **build**: update dependencies
-* **ci**: update circleci node version
-* **ci**: update circleci to v2
-* **docs**: add contributor
-* **docs**: update README
-* **refactor**: update .gitignore
+- **build**: update dependencies
+- **ci**: update circleci node version
+- **ci**: update circleci to v2
+- **docs**: add contributor
+- **docs**: update README
+- **refactor**: update .gitignore
 
 ## v2.1.1
 
-* **fix**: remove airbnb config
+- **fix**: remove airbnb config
 
 ## v2.1.0
 
 ### Template Updates
 
-* **ci**: update node version
-* **docs**: update CHANGELOG
-* **style**: improve prettier
+- **ci**: update node version
+- **docs**: update CHANGELOG
+- **style**: improve prettier
 
 ### Generator Updates
 
-* **build**: update dependencies
-* **ci**: update node version
-* **refactor**: format using airbnb
-* **refactor**: improve codebase
-* **style**: add airbnb
-* **style**: improve prettier
-* **test**: improve tests
-* **test**: split tests
+- **build**: update dependencies
+- **ci**: update node version
+- **refactor**: format using airbnb
+- **refactor**: improve codebase
+- **style**: add airbnb
+- **style**: improve prettier
+- **test**: improve tests
+- **test**: split tests
 
 ## v2.0.0
 
 ### Template Updates
 
-* **build**: update `package.json` (update keywords, remove `nodemon`, move dependencies to Generator, format using Prettier)
-* **ci**: update node version on Travis, AppVeyor and CircleCI config files
-* **fix**: rename `.eslintrc` to `.eslintrc.json`
-* **performance**: update `.npmrc` (add `package-lock=false` and `progress=false`)
-* **refactor**: update `.gitignore`
-* **style**: format README using Prettier
-* **style**: change eslint extends from `eslint:recommended` to `prettier`
-* **style**: add prettier config file
-* **test**: format using Prettier
+- **build**: update `package.json` (update keywords, remove `nodemon`, move dependencies to Generator, format using Prettier)
+- **ci**: update node version on Travis, AppVeyor and CircleCI config files
+- **fix**: rename `.eslintrc` to `.eslintrc.json`
+- **performance**: update `.npmrc` (add `package-lock=false` and `progress=false`)
+- **refactor**: update `.gitignore`
+- **style**: format README using Prettier
+- **style**: change eslint extends from `eslint:recommended` to `prettier`
+- **style**: add prettier config file
+- **test**: format using Prettier
 
 ### Generator Updates
 
-* **build**: move dependencies from `package.json` to Generator
-* **build**: remove yarn.lock
-* **build**: update keywords
-* **build**: update yeoman package version
-* **ci**: update node version
-* **docs**: update README
-* **performance**: update .npmrc
-* **refactor**: update .gitignore
-* **style**: add prettier
-* **test**: change testing tool from mocha to jest
+- **build**: move dependencies from `package.json` to Generator
+- **build**: remove yarn.lock
+- **build**: update keywords
+- **build**: update yeoman package version
+- **ci**: update node version
+- **docs**: update README
+- **performance**: update .npmrc
+- **refactor**: update .gitignore
+- **style**: add prettier
+- **test**: change testing tool from mocha to jest
 
 ## v1.0.10
 
-* **fix**: .gitattributes template
+- **fix**: .gitattributes template
 
 ## v1.0.3-9
 
-* **fix**: npm publish
+- **fix**: npm publish
 
 ## v1.0.2
 
-* **fix**: Installation instructions
+- **fix**: Installation instructions
 
 ## v1.0.1
 
-* **docs**: Updating README
+- **docs**: Updating README
 
 ## v1.0.0
 
-* Initial release
+- Initial release

README.md

@@ -1,26 +1,27 @@
 # OSS Project Generator
 
+> Yeoman generator for open source projects.
+
+[![NPM Version][npm-badge]][npm-url]
+[![Downloads][npm-downloads-badge]][npm-downloads-url]
 [![Travis Status][travis-badge]][travis-url]
-[![AppVeyor Status][appveyor-badge]][appveyor-url]
 [![CircleCI Status][circleci-badge]][circleci-url]
+[![AppVeyor Status][appveyor-badge]][appveyor-url]
 [![Coveralls Status][coveralls-badge]][coveralls-url]
-[![NPM Version][npm-badge]][npm-url]
 [![License][license-badge]][license-url]
 
-> Yeoman generator for open source projects.
-
 This generator provides the following features:
 
-* **src** and **test** folder as a starter point to build your project.
-* **EditorConfig** to help you define and maintain consistent coding styles between different editors.
-* **ESLint** to provide a pluggable linting utility for JavaScript.
-* **Prettier** as an opinionated code formatter.
-* **Jest** as a complete and easy to set-up JavaScript testing solution used by Facebook.
-* **Travis** and **CircleCI** as a continuous integration and delivery platform.
-* **Appveyor** as a continuous delivery service for Windows.
-* **Coveralls** to help you track your code coverage over time, and ensure that all your new code is fully covered.
-* **README.md** and **CHANGELOG.md** with information about the project, installation, usage, development, author and license.
-* **Badges** for Travis, Appveyor, CircleCI, Coveralls, npm and License.
+- **src** and **test** folder as a starter point to build your project.
+- **EditorConfig** to help you define and maintain consistent coding styles between different editors.
+- **ESLint** to provide a pluggable linting utility for JavaScript.
+- **Prettier** as an opinionated code formatter.
+- **Jest** as a complete and easy to set-up JavaScript testing solution used by Facebook.
+- **Travis** and **CircleCI** as a continuous integration and delivery platform.
+- **Appveyor** as a continuous delivery service for Windows.
+- **Coveralls** to help you track your code coverage over time, and ensure that all your new code is fully covered.
+- **README.md** and **CHANGELOG.md** with information about the project, installation, usage, development, author and license.
+- **Badges** for Travis, Appveyor, CircleCI, Coveralls, npm and License.
 
 ## Project files
 
@@ -48,21 +49,21 @@ This generator provides the following features:
 
 ## Installation
 
-* Install Yeoman
+- Install Yeoman
 
 ```bash
 $ npm install -g yo
 ```
 
-* Install Generator
+- Install Generator
 
 ```bash
 $ npm install -g generator-oss-project
 ```
 
 ## Usage
 
-* Creating a project
+- Creating a project
 
 ```bash
 # Create a directory for your project
@@ -75,7 +76,7 @@ $ cd awesome-project
 $ yo oss-project
 ```
 
-* Running project
+- Running project
 
 | Action                                   | Usage               |
 | ---------------------------------------- | ------------------- |
@@ -90,9 +91,9 @@ $ yo oss-project
 
 ### Prerequisites
 
-* Install [Node.js](https://nodejs.org)
-* Install [npm](https://www.npmjs.com/)
-* Install Yeoman CLI
+- Install [Node.js](https://nodejs.org)
+- Install [npm](https://www.npmjs.com/)
+- Install Yeoman CLI
 
 ```bash
 $ npm install -g yo
@@ -129,15 +130,17 @@ $ yo oss-project
 
 [MIT](https://github.com/robertoachar/generator-oss-project/blob/master/LICENSE)
 
+[npm-badge]: https://img.shields.io/npm/v/generator-oss-project.svg
+[npm-url]: https://www.npmjs.com/package/generator-oss-project
+[npm-downloads-badge]: https://img.shields.io/npm/dt/generator-oss-project.svg
+[npm-downloads-url]: https://www.npmjs.com/package/generator-oss-project
 [travis-badge]: https://travis-ci.org/robertoachar/generator-oss-project.svg?branch=master
 [travis-url]: https://travis-ci.org/robertoachar/generator-oss-project
-[appveyor-badge]: https://ci.appveyor.com/api/projects/status/github/robertoachar/generator-oss-project?branch=master&svg=true
-[appveyor-url]: https://ci.appveyor.com/project/robertoachar/generator-oss-project
 [circleci-badge]: https://circleci.com/gh/robertoachar/generator-oss-project/tree/master.svg?style=shield
 [circleci-url]: https://circleci.com/gh/robertoachar/generator-oss-project
+[appveyor-badge]: https://ci.appveyor.com/api/projects/status/github/robertoachar/generator-oss-project?branch=master&svg=true
+[appveyor-url]: https://ci.appveyor.com/project/robertoachar/generator-oss-project
 [coveralls-badge]: https://coveralls.io/repos/github/robertoachar/generator-oss-project/badge.svg?branch=master
 [coveralls-url]: https://coveralls.io/github/robertoachar/generator-oss-project?branch=master
-[npm-badge]: https://img.shields.io/npm/v/generator-oss-project.svg
-[npm-url]: https://www.npmjs.com/package/generator-oss-project
 [license-badge]: https://img.shields.io/github/license/robertoachar/generator-oss-project.svg
 [license-url]: https://opensource.org/licenses/MIT

package.json

@@ -1,6 +1,6 @@
 {
   "name": "generator-oss-project",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "description": "Yeoman generator for open source projects.",
   "author": "Roberto Achar <robertoachar@gmail.com>",
   "contributors": [
@@ -40,15 +40,15 @@
     "yeoman-generator": "3.0.0"
   },
   "devDependencies": {
-    "@types/jest": "23.1.5",
+    "@types/jest": "23.3.0",
     "@types/yeoman-generator": "2.0.3",
     "coveralls": "3.0.2",
     "eslint": "4.19.1",
     "eslint-config-airbnb-base": "13.0.0",
     "eslint-config-prettier": "2.9.0",
     "eslint-plugin-import": "2.13.0",
     "eslint-plugin-prettier": "2.6.2",
-    "jest": "23.4.0",
+    "jest": "23.4.1",
     "prettier": "1.13.7",
     "yeoman-assert": "3.1.1",
     "yeoman-test": "1.8.0"