README.md in resonance-0.3.3 vs README.md in resonance-0.4.0
- old
+ new
@@ -49,11 +49,11 @@
```ruby
module Resonatable
include Resonance
- resonate :user, with: :user, by: :follow
+ resonate :user, target: :user, action: :follow
end
```
At last, include this module from each models:
@@ -104,11 +104,11 @@
```ruby
module Resonatable
include Resonance
- resonate :user, with: :post, by: :like
+ resonate :user, target: :post, action: :like
end
class User < ActiveRecord::Base
include Resonatable
end
@@ -135,20 +135,23 @@
```ruby
module Resonatable
include Resonance
- resonate :user, with: :user, by: :follow
- resonate :user, with: :post, by: :like
+ resonate :user, target: :user, action: :follow
+ resonate :user, target: :post, action: :like
end
```
## Customization
If you want to use other foreign key name, you can define it by `:foreign_key` option.
```ruby
-resonate :user, with: :post, by: :like, foreign_key: :post_id # Default is `:target_post_id`
+resonate :user,
+ target: :post,
+ action: :like,
+ foreign_key: { target: :post_id } # Default key is `:target_post_id`
```
## Contributing
1. Fork it ( https://github.com/kami-zh/resonance/fork )