Merge pull request #28 from venuu/readme-for-next-release

Expand README on caveats and version compatibilities

README.md

@@ -11,11 +11,18 @@ branch. This may contain information that is not relevant to the release you are
 
 `JSONAPI::Authorization` adds authorization to the [jsonapi-resources][jr] (JR) gem using [Pundit][pundit].
 
-***PLEASE NOTE:*** This gem is still considered to be ***alpha quality***. Make sure to test for authorization in your application, too. We should have coverage of all operations, though. If that isn't the case, please [open an issue][issues].
-
   [jr]: https://github.com/cerebris/jsonapi-resources "A resource-focused Rails library for developing JSON API compliant servers."
   [pundit]: https://github.com/elabs/pundit "Minimal authorization through OO design and pure Ruby classes"
-  [issues]: https://github.com/venuu/jsonapi-authorization/issues
+
+## Caveats
+
+Make sure to test for authorization in your application, too. We should have coverage of all operations, though. If that isn't the case, please [open an issue][issues].
+
+This gem should work out-of-the box for simple cases. The default authorizer might be overly restrictive for [more complex cases][complex-case].
+
+The API is subject to change between minor version bumps until we reach v1.0.0.
+
+  [complex-case]: https://github.com/venuu/jsonapi-authorization/issues/15
 
 ## Installation
 
@@ -33,6 +40,13 @@ Or install it yourself as:
 
     $ gem install jsonapi-authorization
 
+## Compatibility
+
+* `v0.6.x` supports JR `v0.7.x`
+* `v0.8.x` supports JR `v0.8.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].
+
 ## Usage
 
 First make sure you have a Pundit policy specified for every backing model that your JR resources use.
@@ -110,3 +124,5 @@ Originally based on discussion and code samples by [@barelyknown](https://github
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/venuu/jsonapi-authorization.
+
+  [issues]: https://github.com/venuu/jsonapi-authorization/issues