Skip to content

Commit 16f4a58

Browse files
gep13gep13
committed
(GH-34) Badges for Coveralls and Coverity
1 parent 390c4bc commit 16f4a58

File tree

1 file changed

+61
-57
lines changed

1 file changed

+61
-57
lines changed

‎README.md

Lines changed: 61 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,65 @@
1-
![Icon](https://raw.github.com/gep13/GitHubReleaseManager/develop/Icons/package_icon_no_credit.png)
2-
3-
Do you detest creating release notes for your software applications hosted on GitHub? If so, this is the tool for you.
4-
5-
Using a simple set of configuration properties, you can fully automate the creation and export of Release Notes from your GitHub hosted project.
6-
7-
As an example see this [Release](https://github.com/chocolatey/ChocolateyGUI/releases/tag/0.12.0) for [ChocolateyGUI](https://github.com/chocolatey/ChocolateyGUI) which was created using GitHubReleaseManager.
8-
9-
GitHubReleaseManager allows you to:
10-
1+
![Icon](https://raw.github.com/gep13/GitHubReleaseManager/develop/Icons/package_icon_no_credit.png)
2+
3+
[![License](http://img.shields.io/:license-mit-blue.svg)](http://gep13.mit-license.org)
4+
[![Coverage Status](https://coveralls.io/repos/gep13/GitHubReleaseManager/badge.svg?branch=develop)](https://coveralls.io/r/gep13/GitHubReleaseManager?branch=develop)
5+
[![Coverity Scan Build Status](https://scan.coverity.com/projects/4534/badge.svg)](https://scan.coverity.com/projects/4534)
6+
7+
Do you detest creating release notes for your software applications hosted on GitHub? If so, this is the tool for you.
8+
9+
Using a simple set of configuration properties, you can fully automate the creation and export of Release Notes from your GitHub hosted project.
10+
11+
As an example see this [Release](https://github.com/chocolatey/ChocolateyGUI/releases/tag/0.12.0) for [ChocolateyGUI](https://github.com/chocolatey/ChocolateyGUI) which was created using GitHubReleaseManager.
12+
13+
GitHubReleaseManager allows you to:
14+
1115
- Create Draft Releases from a milestone
1216
- Attach assets to an existing release
1317
- Close a milestone
1418
- Publish a Draft Release
15-
- Export all Release Notes for a Project
16-
17-
## Installation
18-
19-
You can install GitHubReleaseManager via Chocolatey by executing:
20-
21-
`choco install githubreleasemanager`
22-
23-
If you are interested in trying out the latest pre-release version of GitHubReleaseManager then you can use the following installation command:
24-
25-
`choco install githubreleasemanager -source https://www.myget.org/F/ghrm_develop/ -pre`
26-
27-
This uses the public GitHubReleaseManager feed which is hosted on [MyGet.org](https://www.myget.org/)
28-
29-
## Build Status
30-
31-
AppVeyor
32-
-------------
33-
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/20hvqfnv6dlwqld7/branch/develop?svg=true)](https://ci.appveyor.com/project/GaryEwanPark/githubreleasemanager)
34-
35-
## Chat Room
36-
37-
Come join in the conversation about GitHubReleaseManager in our Gitter Chat Room
38-
39-
[![Join the chat at https://gitter.im/gep13/GitHubReleaseManager](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/gep13/GitHubReleaseManager?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
40-
41-
## Contributing
42-
43-
If you would like to contribute code or help squash a bug or two, that's awesome. Please familiarize yourself with [CONTRIBUTING](https://github.com/gep13/GitHubReleaseManager/blob/develop/CONTRIBUTING.md).
44-
45-
## Committers
46-
47-
Committers, you should be very familiar with [COMMITTERS](https://github.com/gep13/GitHubReleaseManager/blob/develop/COMMITTERS.md).
48-
49-
## Credits
50-
51-
GitHubReleaseManager is brought to you by quite a few people and frameworks. See [CREDITS](https://github.com/gep13/GitHubReleaseManager/blob/develop/Documentation/legal/CREDITS.md) for full information.
52-
53-
Full original credit has to go to the people at [Particular Software](http://www.particular.net/), without whom this project would not have been possible. They originally created the [GitHubReleaseNotes](https://github.com/Particular/GitHubReleaseNotes) project, which GitHubReleaseManager is based on, and draws a lot of inspiration from.
54-
55-
Where GitHubReleaseNotes uses a set of fixed configuration, based on Particular's internal usage requirements, GitHubReleaseManager attempts to be fully configurable, so that the end user can decide what should be done when creating and exporting Release Notes on GitHub. Huge thanks to the people at Particular for their support in helping me create this project. For more information about what has changed between GitHubReleaseNotes and GitHubReleaseManager, see this [issue](https://github.com/gep13/GitHubReleaseManager/issues/24).
56-
57-
In addition, a large thank you has to go to again [Particular Software](http://www.particular.net/) and the contributors behind the [GitVersion](https://github.com/ParticularLabs/GitVersion) Project. GitHubReleaseManager draws on the work done in that project in terms of initializing and using a YAML configuration file to allow setting of configuration properties at run-time.
58-
59-
## Icon
60-
61-
<a href="http://thenounproject.com/term/pull-request/116189/" target="_blank">Pull-request</a> designed by <a href="http://thenounproject.com/richard.slater/" target="_blank">Richard Slater</a> from The Noun Project.
19+
- Export all Release Notes for a Project
20+
21+
## Installation
22+
23+
You can install GitHubReleaseManager via Chocolatey by executing:
24+
25+
`choco install githubreleasemanager`
26+
27+
If you are interested in trying out the latest pre-release version of GitHubReleaseManager then you can use the following installation command:
28+
29+
`choco install githubreleasemanager -source https://www.myget.org/F/ghrm_develop/ -pre`
30+
31+
This uses the public GitHubReleaseManager feed which is hosted on [MyGet.org](https://www.myget.org/)
32+
33+
## Build Status
34+
35+
AppVeyor
36+
-------------
37+
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/20hvqfnv6dlwqld7/branch/develop?svg=true)](https://ci.appveyor.com/project/GaryEwanPark/githubreleasemanager)
38+
39+
## Chat Room
40+
41+
Come join in the conversation about GitHubReleaseManager in our Gitter Chat Room
42+
43+
[![Join the chat at https://gitter.im/gep13/GitHubReleaseManager](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/gep13/GitHubReleaseManager?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
44+
45+
## Contributing
46+
47+
If you would like to contribute code or help squash a bug or two, that's awesome. Please familiarize yourself with [CONTRIBUTING](https://github.com/gep13/GitHubReleaseManager/blob/develop/CONTRIBUTING.md).
48+
49+
## Committers
50+
51+
Committers, you should be very familiar with [COMMITTERS](https://github.com/gep13/GitHubReleaseManager/blob/develop/COMMITTERS.md).
52+
53+
## Credits
54+
55+
GitHubReleaseManager is brought to you by quite a few people and frameworks. See [CREDITS](https://github.com/gep13/GitHubReleaseManager/blob/develop/Documentation/legal/CREDITS.md) for full information.
56+
57+
Full original credit has to go to the people at [Particular Software](http://www.particular.net/), without whom this project would not have been possible. They originally created the [GitHubReleaseNotes](https://github.com/Particular/GitHubReleaseNotes) project, which GitHubReleaseManager is based on, and draws a lot of inspiration from.
58+
59+
Where GitHubReleaseNotes uses a set of fixed configuration, based on Particular's internal usage requirements, GitHubReleaseManager attempts to be fully configurable, so that the end user can decide what should be done when creating and exporting Release Notes on GitHub. Huge thanks to the people at Particular for their support in helping me create this project. For more information about what has changed between GitHubReleaseNotes and GitHubReleaseManager, see this [issue](https://github.com/gep13/GitHubReleaseManager/issues/24).
60+
61+
In addition, a large thank you has to go to again [Particular Software](http://www.particular.net/) and the contributors behind the [GitVersion](https://github.com/ParticularLabs/GitVersion) Project. GitHubReleaseManager draws on the work done in that project in terms of initializing and using a YAML configuration file to allow setting of configuration properties at run-time.
62+
63+
## Icon
64+
65+
<a href="http://thenounproject.com/term/pull-request/116189/" target="_blank">Pull-request</a> designed by <a href="http://thenounproject.com/richard.slater/" target="_blank">Richard Slater</a> from The Noun Project.

0 commit comments

Comments
 (0)