Commit 6c1819ccb4b01d177cb299fb123fb989cc124189
1 parent
5a6bcb7f
Exists in
master
and in
21 other branches
Only one space
Showing
1 changed file
with
13 additions
and
13 deletions
Show diff stats
README.md
... | ... | @@ -2,7 +2,7 @@ |
2 | 2 | |
3 | 3 | :rocket: Intelligent search made easy |
4 | 4 | |
5 | -Searchkick learns what **your users** are looking for. As more people search, it gets smarter and the results get better. It’s friendly for developers - and magical for your users. | |
5 | +Searchkick learns what **your users** are looking for. As more people search, it gets smarter and the results get better. It’s friendly for developers - and magical for your users. | |
6 | 6 | |
7 | 7 | Searchkick handles: |
8 | 8 | |
... | ... | @@ -265,7 +265,7 @@ User.search "fresh honey", match: :phrase |
265 | 265 | |
266 | 266 | ### Language |
267 | 267 | |
268 | -Searchkick defaults to English for stemming. To change this, use: | |
268 | +Searchkick defaults to English for stemming. To change this, use: | |
269 | 269 | |
270 | 270 | ```ruby |
271 | 271 | class Product < ActiveRecord::Base |
... | ... | @@ -366,7 +366,7 @@ class Product < ActiveRecord::Base |
366 | 366 | end |
367 | 367 | ``` |
368 | 368 | |
369 | -Searchkick uses `find_in_batches` to import documents. To eager load associations, use the `search_import` scope. | |
369 | +Searchkick uses `find_in_batches` to import documents. To eager load associations, use the `search_import` scope. | |
370 | 370 | |
371 | 371 | ```ruby |
372 | 372 | class Product < ActiveRecord::Base |
... | ... | @@ -374,7 +374,7 @@ class Product < ActiveRecord::Base |
374 | 374 | end |
375 | 375 | ``` |
376 | 376 | |
377 | -By default, all records are indexed. To control which records are indexed, use the `should_index?` method together with the `search_import` scope. | |
377 | +By default, all records are indexed. To control which records are indexed, use the `should_index?` method together with the `search_import` scope. | |
378 | 378 | |
379 | 379 | ```ruby |
380 | 380 | class Product < ActiveRecord::Base |
... | ... | @@ -452,7 +452,7 @@ end |
452 | 452 | |
453 | 453 | #### Associations |
454 | 454 | |
455 | -Data is **not** automatically synced when an association is updated. If this is desired, add a callback to reindex: | |
455 | +Data is **not** automatically synced when an association is updated. If this is desired, add a callback to reindex: | |
456 | 456 | |
457 | 457 | ```ruby |
458 | 458 | class Image < ActiveRecord::Base |
... | ... | @@ -480,11 +480,11 @@ Product.search "apple", track: {user_id: current_user.id} |
480 | 480 | |
481 | 481 | ### Keep Getting Better |
482 | 482 | |
483 | -Searchkick can use conversion data to learn what users are looking for. If a user searches for “ice cream” and adds Ben & Jerry’s Chunky Monkey to the cart (our conversion metric at Instacart), that item gets a little more weight for similar searches. | |
483 | +Searchkick can use conversion data to learn what users are looking for. If a user searches for “ice cream” and adds Ben & Jerry’s Chunky Monkey to the cart (our conversion metric at Instacart), that item gets a little more weight for similar searches. | |
484 | 484 | |
485 | -The first step is to define your conversion metric and start tracking conversions. The database works well for low volume, but feel free to use Redis or another datastore. | |
485 | +The first step is to define your conversion metric and start tracking conversions. The database works well for low volume, but feel free to use Redis or another datastore. | |
486 | 486 | |
487 | -You do **not** need to clean up the search queries. Searchkick automatically treats `apple` and `APPLES` the same. | |
487 | +You do **not** need to clean up the search queries. Searchkick automatically treats `apple` and `APPLES` the same. | |
488 | 488 | |
489 | 489 | Next, add conversions to the index. |
490 | 490 | |
... | ... | @@ -512,7 +512,7 @@ rake searchkick:reindex CLASS=Product |
512 | 512 | |
513 | 513 | ### Personalized Results |
514 | 514 | |
515 | -Order results differently for each user. For example, show a user’s previously purchased products before other results. | |
515 | +Order results differently for each user. For example, show a user’s previously purchased products before other results. | |
516 | 516 | |
517 | 517 | ```ruby |
518 | 518 | class Product < ActiveRecord::Base |
... | ... | @@ -539,7 +539,7 @@ Autocomplete predicts what a user will type, making the search experience faster |
539 | 539 | |
540 | 540 | **Note:** If you only have a few thousand records, don’t use Searchkick for autocomplete. It’s *much* faster to load all records into JavaScript and autocomplete there (eliminates network requests). |
541 | 541 | |
542 | -First, specify which fields use this feature. This is necessary since autocomplete can increase the index size significantly, but don’t worry - this gives you blazing faster queries. | |
542 | +First, specify which fields use this feature. This is necessary since autocomplete can increase the index size significantly, but don’t worry - this gives you blazing faster queries. | |
543 | 543 | |
544 | 544 | ```ruby |
545 | 545 | class Book < ActiveRecord::Base |
... | ... | @@ -951,7 +951,7 @@ See the [complete list of analyzers](lib/searchkick/index.rb#L209). |
951 | 951 | |
952 | 952 | ## Deployment |
953 | 953 | |
954 | -Searchkick uses `ENV["ELASTICSEARCH_URL"]` for the Elasticsearch server. This defaults to `http://localhost:9200`. | |
954 | +Searchkick uses `ENV["ELASTICSEARCH_URL"]` for the Elasticsearch server. This defaults to `http://localhost:9200`. | |
955 | 955 | |
956 | 956 | ### Heroku |
957 | 957 | |
... | ... | @@ -1378,7 +1378,7 @@ Product.search "ah", misspellings: {prefix_length: 2} # ah, no aha |
1378 | 1378 | |
1379 | 1379 | ## Large Data Sets |
1380 | 1380 | |
1381 | -For large data sets, check out [Keeping Elasticsearch in Sync](https://www.elastic.co/blog/found-keeping-elasticsearch-in-sync). Searchkick will make this easy in the future. | |
1381 | +For large data sets, check out [Keeping Elasticsearch in Sync](https://www.elastic.co/blog/found-keeping-elasticsearch-in-sync). Searchkick will make this easy in the future. | |
1382 | 1382 | |
1383 | 1383 | ## Testing |
1384 | 1384 | |
... | ... | @@ -1478,7 +1478,7 @@ Before `0.3.0`, locations were indexed incorrectly. When upgrading, be sure to r |
1478 | 1478 | |
1479 | 1479 | ### Inconsistent Scores |
1480 | 1480 | |
1481 | -Due to the distributed nature of Elasticsearch, you can get incorrect results when the number of documents in the index is low. You can [read more about it here](https://www.elastic.co/blog/understanding-query-then-fetch-vs-dfs-query-then-fetch). To fix this, do: | |
1481 | +Due to the distributed nature of Elasticsearch, you can get incorrect results when the number of documents in the index is low. You can [read more about it here](https://www.elastic.co/blog/understanding-query-then-fetch-vs-dfs-query-then-fetch). To fix this, do: | |
1482 | 1482 | |
1483 | 1483 | ```ruby |
1484 | 1484 | class Product < ActiveRecord::Base | ... | ... |