README.md in jsonapi-authorization-2.0.0 vs README.md in jsonapi-authorization-3.0.0

- old
+ new

@@ -53,14 +53,22 @@ ## Compatibility * `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. Hook up this gem as the default processor for JR, and optionally allow rescuing from `Pundit::NotAuthorizedError` to output better errors for unauthorized requests: @@ -183,11 +191,10 @@ Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)): <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore --> -| [<img src="https://avatars.githubusercontent.com/u/482561?v=3" width="100px;" alt="Vesa Laakso"/><br /><sub><b>Vesa Laakso</b></sub>](http://vesalaakso.com)<br />[๐Ÿ’ป](https://github.com/Venuu/jsonapi-authorization/commits?author=valscion "Code") [๐Ÿ“–](https://github.com/Venuu/jsonapi-authorization/commits?author=valscion "Documentation") [๐Ÿš‡](#infra-valscion "Infrastructure (Hosting, Build-Tools, etc)") [โš ๏ธ](https://github.com/Venuu/jsonapi-authorization/commits?author=valscion "Tests") [๐Ÿ›](https://github.com/Venuu/jsonapi-authorization/issues?q=author%3Avalscion "Bug reports") [๐Ÿ’ฌ](#question-valscion "Answering Questions") [๐Ÿ‘€](#review-valscion "Reviewed Pull Requests") | [<img src="https://avatars.githubusercontent.com/u/562204?v=3" width="100px;" alt="Emil Sรฅgfors"/><br /><sub><b>Emil Sรฅgfors</b></sub>](https://github.com/lime)<br />[๐Ÿ’ป](https://github.com/Venuu/jsonapi-authorization/commits?author=lime "Code") [๐Ÿ“–](https://github.com/Venuu/jsonapi-authorization/commits?author=lime "Documentation") [๐Ÿš‡](#infra-lime "Infrastructure (Hosting, Build-Tools, etc)") [โš ๏ธ](https://github.com/Venuu/jsonapi-authorization/commits?author=lime "Tests") [๐Ÿ›](https://github.com/Venuu/jsonapi-authorization/issues?q=author%3Alime "Bug reports") [๐Ÿ’ฌ](#question-lime "Answering Questions") [๐Ÿ‘€](#review-lime "Reviewed Pull Requests") | [<img src="https://avatars.githubusercontent.com/u/1591161?v=3" width="100px;" alt="Matthias Grundmann"/><br /><sub><b>Matthias Grundmann</b></sub>](https://github.com/matthias-g)<br />[๐Ÿ’ป](https://github.com/Venuu/jsonapi-authorization/commits?author=matthias-g "Code") [๐Ÿ“–](https://github.com/Venuu/jsonapi-authorization/commits?author=matthias-g "Documentation") [โš ๏ธ](https://github.com/Venuu/jsonapi-authorization/commits?author=matthias-g "Tests") [๐Ÿ’ฌ](#question-matthias-g "Answering Questions") | [<img src="https://avatars.githubusercontent.com/u/1322?v=3" width="100px;" alt="Thibaud Guillaume-Gentil"/><br /><sub><b>Thibaud Guillaume-Gentil</b></sub>](http://thibaud.gg)<br />[๐Ÿ’ป](https://github.com/Venuu/jsonapi-authorization/commits?author=thibaudgg "Code") | [<img src="https://avatars.githubusercontent.com/u/71660?v=3" width="100px;" alt="Daniel Schweighรถfer"/><br /><sub><b>Daniel Schweighรถfer</b></sub>](http://netsteward.net)<br />[๐Ÿ’ป](https://github.com/Venuu/jsonapi-authorization/commits?author=acid "Code") | [<img src="https://avatars.githubusercontent.com/u/5076967?v=3" width="100px;" alt="Bruno Sofiato"/><br /><sub><b>Bruno Sofiato</b></sub>](https://github.com/bsofiato)<br />[๐Ÿ’ป](https://github.com/Venuu/jsonapi-authorization/commits?author=bsofiato "Code") | [<img src="https://avatars.githubusercontent.com/u/1896026?v=3" width="100px;" alt="Adam Robertson"/><br /><sub><b>Adam Robertson</b></sub>](https://github.com/arcreative)<br />[๐Ÿ“–](https://github.com/Venuu/jsonapi-authorization/commits?author=arcreative "Documentation") | -| :---: | :---: | :---: | :---: | :---: | :---: | :---: | -| [<img src="https://avatars3.githubusercontent.com/u/4742306?v=3" width="100px;" alt="Greg Fisher"/><br /><sub><b>Greg Fisher</b></sub>](https://github.com/gnfisher)<br />[๐Ÿ’ป](https://github.com/Venuu/jsonapi-authorization/commits?author=gnfisher "Code") [โš ๏ธ](https://github.com/Venuu/jsonapi-authorization/commits?author=gnfisher "Tests") | [<img src="https://avatars3.githubusercontent.com/u/370182?v=3" width="100px;" alt="Sam"/><br /><sub><b>Sam</b></sub>](http://samlh.com)<br />[๐Ÿ’ป](https://github.com/Venuu/jsonapi-authorization/commits?author=handlers "Code") [โš ๏ธ](https://github.com/Venuu/jsonapi-authorization/commits?author=handlers "Tests") | [<img src="https://avatars0.githubusercontent.com/u/2738630?v=3" width="100px;" alt="Justas Palumickas"/><br /><sub><b>Justas Palumickas</b></sub>](https://jpalumickas.com)<br />[๐Ÿ›](https://github.com/Venuu/jsonapi-authorization/issues?q=author%3Ajpalumickas "Bug reports") [๐Ÿ’ป](https://github.com/Venuu/jsonapi-authorization/commits?author=jpalumickas "Code") [โš ๏ธ](https://github.com/Venuu/jsonapi-authorization/commits?author=jpalumickas "Tests") | [<img src="https://avatars1.githubusercontent.com/u/26158?v=4" width="100px;" alt="Nicholas Rutherford"/><br /><sub><b>Nicholas Rutherford</b></sub>](http://www.google.co.uk/profiles/nick.rutherford)<br />[๐Ÿ’ป](https://github.com/Venuu/jsonapi-authorization/commits?author=nruth "Code") [โš ๏ธ](https://github.com/Venuu/jsonapi-authorization/commits?author=nruth "Tests") [๐Ÿš‡](#infra-nruth "Infrastructure (Hosting, Build-Tools, etc)") | [<img src="https://avatars2.githubusercontent.com/u/5302372?v=4" width="100px;" alt="Matthijsy"/><br /><sub><b>Matthijsy</b></sub>](https://github.com/Matthijsy)<br />[๐Ÿ›](https://github.com/Venuu/jsonapi-authorization/issues?q=author%3AMatthijsy "Bug reports") [โš ๏ธ](https://github.com/Venuu/jsonapi-authorization/commits?author=Matthijsy "Tests") [๐Ÿ’ป](https://github.com/Venuu/jsonapi-authorization/commits?author=Matthijsy "Code") | +<table><tr><td align="center"><a href="http://vesalaakso.com"><img src="https://avatars.githubusercontent.com/u/482561?v=3" width="100px;" alt="Vesa Laakso"/><br /><sub><b>Vesa Laakso</b></sub></a><br /><a href="https://github.com/Venuu/jsonapi-authorization/commits?author=valscion" title="Code">๐Ÿ’ป</a> <a href="https://github.com/Venuu/jsonapi-authorization/commits?author=valscion" title="Documentation">๐Ÿ“–</a> <a href="#infra-valscion" title="Infrastructure (Hosting, Build-Tools, etc)">๐Ÿš‡</a> <a href="https://github.com/Venuu/jsonapi-authorization/commits?author=valscion" title="Tests">โš ๏ธ</a> <a href="https://github.com/Venuu/jsonapi-authorization/issues?q=author%3Avalscion" title="Bug reports">๐Ÿ›</a> <a href="#question-valscion" title="Answering Questions">๐Ÿ’ฌ</a> <a href="#review-valscion" title="Reviewed Pull Requests">๐Ÿ‘€</a></td><td align="center"><a href="https://github.com/lime"><img src="https://avatars.githubusercontent.com/u/562204?v=3" width="100px;" alt="Emil Sรฅgfors"/><br /><sub><b>Emil Sรฅgfors</b></sub></a><br /><a href="https://github.com/Venuu/jsonapi-authorization/commits?author=lime" title="Code">๐Ÿ’ป</a> <a href="https://github.com/Venuu/jsonapi-authorization/commits?author=lime" title="Documentation">๐Ÿ“–</a> <a href="#infra-lime" title="Infrastructure (Hosting, Build-Tools, etc)">๐Ÿš‡</a> <a href="https://github.com/Venuu/jsonapi-authorization/commits?author=lime" title="Tests">โš ๏ธ</a> <a href="https://github.com/Venuu/jsonapi-authorization/issues?q=author%3Alime" title="Bug reports">๐Ÿ›</a> <a href="#question-lime" title="Answering Questions">๐Ÿ’ฌ</a> <a href="#review-lime" title="Reviewed Pull Requests">๐Ÿ‘€</a></td><td align="center"><a href="https://github.com/matthias-g"><img src="https://avatars.githubusercontent.com/u/1591161?v=3" width="100px;" alt="Matthias Grundmann"/><br /><sub><b>Matthias Grundmann</b></sub></a><br /><a href="https://github.com/Venuu/jsonapi-authorization/commits?author=matthias-g" title="Code">๐Ÿ’ป</a> <a href="https://github.com/Venuu/jsonapi-authorization/commits?author=matthias-g" title="Documentation">๐Ÿ“–</a> <a href="https://github.com/Venuu/jsonapi-authorization/commits?author=matthias-g" title="Tests">โš ๏ธ</a> <a href="#question-matthias-g" title="Answering Questions">๐Ÿ’ฌ</a></td><td align="center"><a href="http://thibaud.gg"><img src="https://avatars.githubusercontent.com/u/1322?v=3" width="100px;" alt="Thibaud Guillaume-Gentil"/><br /><sub><b>Thibaud Guillaume-Gentil</b></sub></a><br /><a href="https://github.com/Venuu/jsonapi-authorization/commits?author=thibaudgg" title="Code">๐Ÿ’ป</a></td><td align="center"><a href="http://netsteward.net"><img src="https://avatars.githubusercontent.com/u/71660?v=3" width="100px;" alt="Daniel Schweighรถfer"/><br /><sub><b>Daniel Schweighรถfer</b></sub></a><br /><a href="https://github.com/Venuu/jsonapi-authorization/commits?author=acid" title="Code">๐Ÿ’ป</a></td><td align="center"><a href="https://github.com/bsofiato"><img src="https://avatars.githubusercontent.com/u/5076967?v=3" width="100px;" alt="Bruno Sofiato"/><br /><sub><b>Bruno Sofiato</b></sub></a><br /><a href="https://github.com/Venuu/jsonapi-authorization/commits?author=bsofiato" title="Code">๐Ÿ’ป</a></td><td align="center"><a href="https://github.com/arcreative"><img src="https://avatars.githubusercontent.com/u/1896026?v=3" width="100px;" alt="Adam Robertson"/><br /><sub><b>Adam Robertson</b></sub></a><br /><a href="https://github.com/Venuu/jsonapi-authorization/commits?author=arcreative" title="Documentation">๐Ÿ“–</a></td></tr><tr><td align="center"><a href="https://github.com/gnfisher"><img src="https://avatars3.githubusercontent.com/u/4742306?v=3" width="100px;" alt="Greg Fisher"/><br /><sub><b>Greg Fisher</b></sub></a><br /><a href="https://github.com/Venuu/jsonapi-authorization/commits?author=gnfisher" title="Code">๐Ÿ’ป</a> <a href="https://github.com/Venuu/jsonapi-authorization/commits?author=gnfisher" title="Tests">โš ๏ธ</a></td><td align="center"><a href="http://samlh.com"><img src="https://avatars3.githubusercontent.com/u/370182?v=3" width="100px;" alt="Sam"/><br /><sub><b>Sam</b></sub></a><br /><a href="https://github.com/Venuu/jsonapi-authorization/commits?author=handlers" title="Code">๐Ÿ’ป</a> <a href="https://github.com/Venuu/jsonapi-authorization/commits?author=handlers" title="Tests">โš ๏ธ</a></td><td align="center"><a href="https://jpalumickas.com"><img src="https://avatars0.githubusercontent.com/u/2738630?v=3" width="100px;" alt="Justas Palumickas"/><br /><sub><b>Justas Palumickas</b></sub></a><br /><a href="https://github.com/Venuu/jsonapi-authorization/issues?q=author%3Ajpalumickas" title="Bug reports">๐Ÿ›</a> <a href="https://github.com/Venuu/jsonapi-authorization/commits?author=jpalumickas" title="Code">๐Ÿ’ป</a> <a href="https://github.com/Venuu/jsonapi-authorization/commits?author=jpalumickas" title="Tests">โš ๏ธ</a></td><td align="center"><a href="http://www.google.co.uk/profiles/nick.rutherford"><img src="https://avatars1.githubusercontent.com/u/26158?v=4" width="100px;" alt="Nicholas Rutherford"/><br /><sub><b>Nicholas Rutherford</b></sub></a><br /><a href="https://github.com/Venuu/jsonapi-authorization/commits?author=nruth" title="Code">๐Ÿ’ป</a> <a href="https://github.com/Venuu/jsonapi-authorization/commits?author=nruth" title="Tests">โš ๏ธ</a> <a href="#infra-nruth" title="Infrastructure (Hosting, Build-Tools, etc)">๐Ÿš‡</a></td><td align="center"><a href="https://github.com/Matthijsy"><img src="https://avatars2.githubusercontent.com/u/5302372?v=4" width="100px;" alt="Matthijsy"/><br /><sub><b>Matthijsy</b></sub></a><br /><a href="https://github.com/Venuu/jsonapi-authorization/issues?q=author%3AMatthijsy" title="Bug reports">๐Ÿ›</a> <a href="https://github.com/Venuu/jsonapi-authorization/commits?author=Matthijsy" title="Tests">โš ๏ธ</a> <a href="https://github.com/Venuu/jsonapi-authorization/commits?author=Matthijsy" title="Code">๐Ÿ’ป</a></td><td align="center"><a href="https://github.com/brianswko"><img src="https://avatars0.githubusercontent.com/u/3952486?v=4" width="100px;" alt="brianswko"/><br /><sub><b>brianswko</b></sub></a><br /><a href="https://github.com/Venuu/jsonapi-authorization/issues?q=author%3Abrianswko" title="Bug reports">๐Ÿ›</a> <a href="https://github.com/Venuu/jsonapi-authorization/commits?author=brianswko" title="Tests">โš ๏ธ</a> <a href="https://github.com/Venuu/jsonapi-authorization/commits?author=brianswko" title="Code">๐Ÿ’ป</a></td></tr></table> + <!-- ALL-CONTRIBUTORS-LIST:END --> This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!