Updated readme for conversions_term [skip ci]

Andrew Kane
1 parent 5fcb7e5c
Showing 2 changed files with 8 additions and 2 deletions Show diff stats
CHANGELOG.md
README.md
 ## 2.3.1 [unreleased]
  
+- Added `conversions_term` option
 - Added support for passing fields to `suggest` option
 - Fixed `page_view_entries` for Kaminari
  
@@ -1563,6 +1563,12 @@ class Product &lt; ActiveRecord::Base
 end
 ```
  
+Use a different term for boosting by conversions [master]
+
+```ruby
+Product.search("banana", conversions_term: "organic banana")
+```
+
 Multiple conversion fields
  
 ```ruby
@@ -1587,10 +1593,9 @@ end
 and during query time:
  
 ```ruby
-Product.search("banana") # boost by both fields (default) and term (banana) will be used for both matching and boosting.
+Product.search("banana") # boost by both fields (default)
 Product.search("banana", conversions: "total_conversions") # only boost by total_conversions
 Product.search("banana", conversions: false) # no conversion boosting
-Product.search("banana", conversions: "total_conversions", conversions_term: "organic banana") # Match banana but boost by organic banana
 ```
  
 Change timeout
1	1	## 2.3.1 [unreleased]
2	2
	3	+- Added `conversions_term` option
3	4	- Added support for passing fields to `suggest` option
4	5	- Fixed `page_view_entries` for Kaminari
5	6
...	...
...	...	@@ -1563,6 +1563,12 @@ class Product < ActiveRecord::Base
1563	1563	end
1564	1564	```
1565	1565
	1566	+Use a different term for boosting by conversions [master]
	1567	+
	1568	+```ruby
	1569	+Product.search("banana", conversions_term: "organic banana")
	1570	+```
	1571	+
1566	1572	Multiple conversion fields
1567	1573
1568	1574	```ruby
...	...	@@ -1587,10 +1593,9 @@ end
1587	1593	and during query time:
1588	1594
1589	1595	```ruby
1590		-Product.search("banana") # boost by both fields (default) and term (banana) will be used for both matching and boosting.
	1596	+Product.search("banana") # boost by both fields (default)
1591	1597	Product.search("banana", conversions: "total_conversions") # only boost by total_conversions
1592	1598	Product.search("banana", conversions: false) # no conversion boosting
1593		-Product.search("banana", conversions: "total_conversions", conversions_term: "organic banana") # Match banana but boost by organic banana
1594	1599	```
1595	1600
1596	1601	Change timeout
...	...