Skip to content

Commit d789cc4

Browse files
committed
update README
1 parent 554e23c commit d789cc4

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,22 @@ Generate a changelog listing all merged requests since the last release of the r
55
## Do it online:
66
[![Heroku](https://pyheroku-badge.herokuapp.com/?app=gitlab-release-notes)](https://gitlab-release-notes.herokuapp.com/)
77
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/vuillaut/GitlabReleaseNotesGenerator/HEAD?labpath=generate.ipynb)
8+
9+
10+
## Install and run locally
11+
12+
To install:
13+
```
14+
pip install gitlab_release_notes
15+
```
16+
17+
Then run:
18+
```
19+
gitlab-release-notes --help
20+
```
21+
22+
## Heroku
23+
24+
Heroku is setup in the `heroku` branch.
25+
- make a new release of `gitlab_release_notes`
26+
- manually deploy from https://dashboard.heroku.com/apps/gitlab-release-notes/deploy/github choosing the heroku branch

0 commit comments

Comments
 (0)