Skip to content

Commit

Permalink
Clarify versioning and link to changelogs in README.md (#123)
Browse files Browse the repository at this point in the history
* Don't specify exact major versions for JR 0.9 support

* Clarify versioning and link to changelogs in README.md
  • Loading branch information
valscion authored Mar 28, 2019
1 parent 0708aaf commit 547ea74
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,18 @@ Or install it yourself as:

* `v0.6.x` supports JR `v0.7.x`
* `v0.8.x` supports JR `v0.8.x`
* `v1.x.x` and `v2.0.x` releases support JR `v0.9.x`
* Later releases support JR `v0.9.x`

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

## Versioning and changelog

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

Given the nature of an authorization library, it is likely that most changes are major version bumps.

Whenever we do changes, we strive to write good changelogs in the [GitHub releases page](https://github.com/venuu/jsonapi-authorization/releases).

## Usage

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

0 comments on commit 547ea74

Please sign in to comment.