From 0877ce0fe69b3c06844e7edb162b78d56118d743 Mon Sep 17 00:00:00 2001 From: Franck Abgrall Date: Thu, 27 Jun 2019 14:48:43 +0200 Subject: [PATCH] :bookmark: v0.5.0 (#81) --- CHANGELOG.md | 18 +++++++++++++++++- README.md | 21 ++++++++++++++++----- package-lock.json | 2 +- package.json | 2 +- 4 files changed, 35 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c3aea05..e0f208c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,21 @@ # Changelog + + +## 0.5.0 (2019-06-27) + +### Added + +- ✨ Get author name from package.json even if author prop is an object ([#75](https://github.com/kefranabg/readme-md-generator/issues/75)) [[688c338](https://github.com/kefranabg/readme-md-generator/commit/688c33833188a5487ff6df024d4993404ee0406c)] +- ✨ Allow user to specify path to custom README template ([#68](https://github.com/kefranabg/readme-md-generator/issues/68)) [[e0d66c0](https://github.com/kefranabg/readme-md-generator/commit/e0d66c002c8108ff3ae142979a5c8003a28a8107)] +- ✨ Allow user to choose a non HTML README template ([#80](https://github.com/kefranabg/readme-md-generator/issues/80)) [[6d5c884](https://github.com/kefranabg/readme-md-generator/commit/6d5c8848c476fc2770204f215ddd6f48d539b4e0)] + +### Changed + +- ⬆️ Update inquirer to the latest version ([#67](https://github.com/kefranabg/readme-md-generator/issues/67)) [[59f69e5](https://github.com/kefranabg/readme-md-generator/commit/59f69e51ec1caae17230d9331a2c14b04bd2825e)] +- ⬆️ Update eslint to the latest version ([#70](https://github.com/kefranabg/readme-md-generator/issues/70)) [[88c96ac](https://github.com/kefranabg/readme-md-generator/commit/88c96ac31acfa12381a33d39a2953f3405053870)] +- ♻️ Refactoring inquirer code ([#69](https://github.com/kefranabg/readme-md-generator/issues/69)) [[802d57d](https://github.com/kefranabg/readme-md-generator/commit/802d57d8af2e2cdcdbddea86c2fa2225db6d4516)] + ## 0.4.1 (2019-06-20) @@ -21,7 +37,7 @@ - 📝 Update doc to use npx ([#55](https://github.com/kefranabg/readme-md-generator/issues/55)) [[77d6fdc](https://github.com/kefranabg/readme-md-generator/commit/77d6fdc4f0a2d9b86d3169f35ed8eab355ebcd68)] - 📝 Replace static version badge by a dynamic one [[99a507d](https://github.com/kefranabg/readme-md-generator/commit/99a507d6ebf54b58aaf941e1752e7e4d16565a53)] - 📝 Update README [[0dff1e5](https://github.com/kefranabg/readme-md-generator/commit/0dff1e5562404559b2ad64ccf0c8fc3d1df73f92)] -- docs: add kefranabg as a contributor ([#57](https://github.com/kefranabg/readme-md-generator/issues/57)) [[e5d9d53](https://github.com/kefranabg/readme-md-generator/commit/e5d9d5376b8341e06005e497728935c2874631b6)] +- 📝 add kefranabg as a contributor ([#57](https://github.com/kefranabg/readme-md-generator/issues/57)) [[e5d9d53](https://github.com/kefranabg/readme-md-generator/commit/e5d9d5376b8341e06005e497728935c2874631b6)] - 👥 Add contributors [[2533cd8](https://github.com/kefranabg/readme-md-generator/commit/2533cd8f2c8c78a043e67ca2bead9b4606606121)] diff --git a/README.md b/README.md index b548f50..eb2fb51 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,14 @@ downloads - License: MIT + License: MIT - + + + gitmoji-changelog + Twitter: FranckAbgrall @@ -22,13 +25,13 @@ `readme-md-generator` is able to read your environment (package.json, git config...) to suggest you default answers during the `README.md` creation process:

- demo + demo

Generated `README.md`:

- cli output + cli output

Example of `package.json` with good meta data: @@ -66,12 +69,20 @@ Just run the following command at the root of your project and answer questions: npx readme-md-generator ``` -OR use default values for all questions (`-y, --yes`): +Or use default values for all questions (`-y`): ```sh npx readme-md-generator -y ``` +Use your own `ejs` README template (`-p`): + +```sh +npx readme-md-generator -p path/to/my/own/template.md +``` + +You can find [ejs README template examples here](https://github.com/kefranabg/readme-md-generator/tree/master/templates). + ## 🤝 Contributing Contributions, issues and feature requests are welcome.
diff --git a/package-lock.json b/package-lock.json index f8ea95c..fd29912 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "readme-md-generator", - "version": "0.4.1", + "version": "0.5.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index aa56091..77c6254 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "readme-md-generator", - "version": "0.4.1", + "version": "0.5.0", "description": "CLI that generates beautiful README.md files.", "main": "src/index.js", "bin": {