Skip to content

Commit afe88f5

Browse files
authored
docs(README): clarify semantic-release versions support
1 parent 8b5126e commit afe88f5

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# semantic-release-github-pr
22

3-
[![Build Status](https://travis-ci.org/Updater/semantic-release-github-pr.svg?branch=master)](https://travis-ci.org/Updater/semantic-release-github-pr) [![npm](https://img.shields.io/npm/v/semantic-release-github-pr.svg)](https://www.npmjs.com/package/semantic-release-github-pr) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
3+
[![Build Status](https://travis-ci.org/pmowrer/semantic-release-github-pr.svg?branch=master)](https://travis-ci.org/pmowrer/semantic-release-github-pr) [![npm](https://img.shields.io/npm/v/semantic-release-github-pr.svg)](https://www.npmjs.com/package/semantic-release-github-pr) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
44

55
Preview the semantic release notes that would result from merging a Github PR.
66

@@ -11,9 +11,11 @@ This set of [`semantic-release`](https://github.com/semantic-release/semantic-re
1111
## Install
1212

1313
```bash
14-
npm install -D semantic-release@next semantic-release-github-pr
14+
npm install -D semantic-release@~15.9.x semantic-release-github-pr
1515
```
1616

17+
NOTE: The current version of this plugin only supports `semantic-release` versions 15.7.x-15.9.x. The next major version will support the current version of `semantic-release`.
18+
1719
## Usage
1820

1921
```bash

0 commit comments

Comments
 (0)