README.md in nazrin-2.0.0 vs README.md in nazrin-2.1.0
- old
+ new
@@ -31,10 +31,11 @@
```ruby
$ bundle exec rails g nazrin:config # execute before including nazrin to model
Nazrin.configure do |config|
config.debug_mode = false
+ config.mode = 'production'
config.search_endpoint = ''
config.document_endpoint = ''
config.region = ''
config.access_key_id = ''
config.secret_access_key = ''
@@ -58,9 +59,30 @@
```ruby
Post.search(where: :foo, includes: :bar).size(1).start(0).query("(and 'content')").query_parser('structured').execute
=> [#<Post id: 1, content: "content">]
```
+
+### Supported pagination libraries
+If you want to use other supported pagination libraries, for example, `nazrin-kaminari` generates `Kaminari::PaginatableArray` instead of `Nazrin::PaginatedArray`.
+
+```ruby
+gem 'nazrin-kaminari'
+```
+
+Currently supported libraries
+
+- kaminari: [nazrin-kaminari](https://github.com/tsuwatch/nazrin-kaminari)
+
+### Sandbox mode
+
+When there is no instance for development and you don't want to request to CloudSearch
+
+```ruby
+Nazrion.config.mode = 'sandbox'
+```
+
+"sandbox" mode where it does nothing with any requests and just returns an empty collection for any searches.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.