Skip to content

Commit 547ea74

Browse files
authored
Clarify versioning and link to changelogs in README.md (#123)
* Don't specify exact major versions for JR 0.9 support * Clarify versioning and link to changelogs in README.md
1 parent 0708aaf commit 547ea74

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,18 @@ Or install it yourself as:
5555

5656
* `v0.6.x` supports JR `v0.7.x`
5757
* `v0.8.x` supports JR `v0.8.x`
58-
* `v1.x.x` and `v2.0.x` releases support JR `v0.9.x`
58+
* Later releases support JR `v0.9.x`
5959

6060
We aim to support the same Ruby and Ruby on Rails versions as `jsonapi-resources` does. If that's not the case, please [open an issue][issues].
6161

62+
## Versioning and changelog
63+
64+
`jsonapi-authorization` follows [Semantic Versioning](https://semver.org/). We prefer to make more major version bumps when we do changes that are likely to be backwards incompatible. That holds true even when it's likely the changes would be backwards compatible for a majority of our users.
65+
66+
Given the nature of an authorization library, it is likely that most changes are major version bumps.
67+
68+
Whenever we do changes, we strive to write good changelogs in the [GitHub releases page](https://github.com/venuu/jsonapi-authorization/releases).
69+
6270
## Usage
6371

6472
First make sure you have a Pundit policy specified for every backing model that your JR resources use.

0 commit comments

Comments
 (0)