README.md in nazrin-0.2.0 vs README.md in nazrin-1.0.0
- old
+ new
@@ -27,20 +27,20 @@
## Usage
### in Ruby on Rails
```ruby
-$ bundle exec rails g nazrin:config
+$ bundle exec rails g nazrin:config # execute before including nazrin to model
Nazrin.configure do |config|
config.debug_mode = false
config.search_endpoint = ''
config.document_endpoint = ''
config.region = ''
config.access_key_id = ''
config.secret_access_key = ''
- # currently support kaminari gem
+ # currently support 'kaminari', 'will_paginate' or 'nazrin'
config.pagination = 'kaminari'
end
```
```ruby
@@ -59,9 +59,14 @@
```
```ruby
Post.search(where: :foo, includes: :bar).size(1).start(0).query("(and 'content')").query_parser('structured').execute
=> [#<Post id: 1, content: "content">]
+```
+
+If you want to use other pagination gem, in your Gemfile
+```ruby
+gem 'kaminari' # or 'will_paginate'
```
## 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.