|
4 | 4 | [](https://badge.fury.io/js/github-release-notes)
|
5 | 5 | [](https://travis-ci.org/github-tools/github-release-notes)
|
6 | 6 | [](https://gitter.im/github-release-notes/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
7 |
| -[](https://codecov.io/gh/github-tools/github-release-notes/) |
| 7 | +[](https://codecov.io/gh/github-tools/github-release-notes/branch/master) |
8 | 8 | [](https://www.npmjs.com/package/github-release-notes)
|
9 | 9 |
|
10 |
| -## Motivation |
11 |
| - |
12 |
| -Everyone loves neat, transparent, informative release notes. |
13 |
| - |
14 |
| -Everyone would also rather avoid maintaining them. What a hassle to have to evaluate what issues have been solved between two points in project's timeline, what types of problems they were, are they important to inform the users about, what issues solved them etc. |
15 |
| - |
16 |
| -Wouldn't it be great to get fantastic release notes compiled for you automaticaly based on all the hard work you put into your GitHub issues and pull requests. |
17 |
| - |
18 | 10 | ## OK, what can `gren` do for me?
|
19 | 11 |
|
20 |
| -`gren` is a small helpful robot that will do for you just that! To put simply, it can create a release from a tag and compile the release notes using issues or commits. |
| 12 | +`gren` is a small helpful robot that will do for you just create a release from a tag and compile the release notes using issues or commits. |
21 | 13 |
|
22 | 14 | It also can generate a `CHANGELOG.md` file based on the release notes (or generate a brand new).
|
23 | 15 |
|
24 |
| -- [The Concept](#the-concept) |
| 16 | +- [The Motivation and Concept](#the-motiviation-and-concept) |
25 | 17 | - [Feed 🤖](#feed-gren-)
|
26 | 18 | - [Installation](#installation)
|
27 | 19 | - [Basic Usage](#basic-usage)
|
28 | 20 | - [Configuration file](#configuration-file)
|
29 | 21 | - [Full Documentation](https://github-tools.github.io/github-release-notes)
|
30 | 22 |
|
31 |
| -## The Concept |
| 23 | +## The Motivation and Concept |
| 24 | + |
| 25 | +Everyone loves neat, transparent, informative release notes. |
| 26 | +Everyone would also rather avoid maintaining them. What a hassle to have to evaluate what issues have been solved between two points in project's timeline, what types of problems they were, are they important to inform the users about, what issues solved them etc. |
| 27 | + |
| 28 | +Wouldn't it be great to get fantastic release notes compiled for you automaticaly based on all the hard work you put into your GitHub issues and pull requests. |
32 | 29 |
|
33 | 30 | The main motivation for bringing `gren` to life was the need for auto generating release notes for every tag in a project.
|
34 | 31 | The process, [as explained here](https://help.github.com/articles/creating-releases/), requires to go to your project's releases page in GitHub, draft that tag as a new release and manually add what I remembered has changed.
|
|
0 commit comments