Skip to content

Commit a6e1e03

Browse files
committed
Update README.md file
1 parent 5800bf4 commit a6e1e03

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,28 @@
44
[![npm version](https://badge.fury.io/js/github-release-notes.svg)](https://badge.fury.io/js/github-release-notes)
55
[![Build Status](https://travis-ci.org/github-tools/github-release-notes.svg?branch=master)](https://travis-ci.org/github-tools/github-release-notes)
66
[![Join the chat at https://gitter.im/github-release-notes/Lobby](https://badges.gitter.im/github-release-notes/Lobby.svg)](https://gitter.im/github-release-notes/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
7-
[![Codecov](https://codecov.io/gh/github-tools/github-release-notes/branch/master/graph/badge.svg)](https://codecov.io/gh/github-tools/github-release-notes/)
7+
[![Codecov](https://codecov.io/gh/github-tools/github-release-notes/branch/master/graph/badge.svg)](https://codecov.io/gh/github-tools/github-release-notes/branch/master)
88
[![npm downloads](https://img.shields.io/npm/dy/github-release-notes.svg)](https://www.npmjs.com/package/github-release-notes)
99

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-
1810
## OK, what can `gren` do for me?
1911

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.
2113

2214
It also can generate a `CHANGELOG.md` file based on the release notes (or generate a brand new).
2315

24-
- [The Concept](#the-concept)
16+
- [The Motivation and Concept](#the-motiviation-and-concept)
2517
- [Feed 🤖](#feed-gren-)
2618
- [Installation](#installation)
2719
- [Basic Usage](#basic-usage)
2820
- [Configuration file](#configuration-file)
2921
- [Full Documentation](https://github-tools.github.io/github-release-notes)
3022

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.
3229

3330
The main motivation for bringing `gren` to life was the need for auto generating release notes for every tag in a project.
3431
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

Comments
 (0)