jsonapi-scopes 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7de8095eaab5c863a6c9f5b400a7457cb89231751c5d1c7005a62b221e9399ad
-  data.tar.gz: b706f80a2097cc969e82b6a1b7894ce0ebc47dfa62dbacf5f5f44d167fbcfe00
+  metadata.gz: 89b5d90e91ab01588a7b2611dc69b9646cc682a70c4cb13c5869b13f64d6204a
+  data.tar.gz: 5eaf3f10e79b2f994ef08e079b3a85d4f0e366b6d57fbf67c42acff5ca92b9a8
 SHA512:
-  metadata.gz: ad5bf7eac4bb99005274a0d8d0fc83e87af270edea7af5b93666471fc8566d3d57a320e21e508c3680412b0d6566d7bde5416497e1020fdb7ff4b1ec8451cede
-  data.tar.gz: 14281865842d6ca46f28ee9c0ce6be5820a2f82fa2196df9ccfc28b7cd646e33015cb2bb9b685b661e59b968eaead5f3e9c674fd3b70ffea7f7a5bb326a7ead8
+  metadata.gz: f80b35cf6f1260e91f46562b8327104d7b1e64f355031d9255ab04feaa8fe34e3a4102060c02614d1c7e21b9957d791e88d903da1c59c62b8ccb207da6d8f185
+  data.tar.gz: beb2ab7e3c7894924790d9fb99447add0030946f3ee32f02c52002ab1b6048df19f263b1b08252055f61b1e17e1888a7b1864247cb8273334e54d32d44ef6862

data/README.md

@@ -4,7 +4,9 @@
 [![](https://img.shields.io/github/license/guillaumebriday/jsonapi-scopes.svg)](https://github.com/guillaumebriday/jsonapi-scopes)
 
 # Jsonapi::Scopes
-This gem allows you to filter and sort an ActiveRecord relation based on a request. This gem follows the [JSON:API specification](https://jsonapi.org/) as closely as possible.
+This gem provides a set of methods which allow you to include, filter and sort an ActiveRecord relation based on a request. It's build to be a simple, robust and scalable system. This gem follows the [JSON:API specification](https://jsonapi.org/) as closely as possible.
+
+This gem is also an unopinionated solution to help you follow the `JSON:API specification`. It does not take care how you want to handle the results. It is a seamless integration in your Rails application and not full library.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -57,7 +59,7 @@ You can specify multiple matching filter values by passing a comma separated lis
 But `/contacts?filter[last_name]=Wayne` will be completely ignored.
 
 ### Sorting
-The gem add `default_sort` and `sortable_fields` methods to control sort options. **Both are optional** and can be overriding in controllers.
+The gem add `default_sort` and `sortable_fields` methods to control sort options. They can be overridden in controllers.
 
 ```ruby
 class Contact < ActiveRecord::Base

data/lib/jsonapi/scopes/version.rb

@@ -2,6 +2,6 @@
 
 module Jsonapi
   module Scopes
-    VERSION = '0.4.0'
+    VERSION = '0.4.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-scopes
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Guillaume Briday