From 6e3c8df61e5152a27548508d7979cfd0dc29fe89 Mon Sep 17 00:00:00 2001 From: Szymon Madeja Date: Wed, 20 May 2015 15:52:56 +0200 Subject: [PATCH] Update readme to avoid confusion The readme doesn't mention that presented method names are dynamic and depend on the `fuzzily_searchable` attribute. It can cause confusion and `undefined method` errors. (example: http://stackoverflow.com/questions/29758059/fuzzily-cannot-get-it-to-work) --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 6a254a0..a6d1e16 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,8 @@ class MyStuff < ActiveRecord::Base end ``` +*Note: The `name` part in the following method calls refers to the `:name` field. Replace it to match your searchable attribute.* + Index your model (will happen automatically for new/updated records): ```ruby