README.textile in thinking-sphinx-raspell-1.0.0 vs README.textile in thinking-sphinx-raspell-1.1.0
- old
+ new
@@ -36,16 +36,31 @@
<pre><code>@articles.redo_with_suggestion
@articles.each do |article|
# ...
end</code></pre>
+h2. Configuration
+
+You can customise the following settings - either in your @config/environment.rb@ file, or perhaps in an initializer. Example syntax below highlights the current defaults.
+
+<pre><code>config = ThinkingSphinx::Configuration.instance
+config.raspell.dictionary = 'en'
+config.raspell.suggestion_mode = :normal
+config.raspell.options['ignore-case'] = true</code></pre>
+
+You can look at the available options using the following two collections:
+
+<pre><code>config = ThinkingSphinx::Configuration.instance
+config.raspell.dictionaries #=> ['en', 'en_GB', 'en_US', ... ]
+config.raspell.suggestion_modes #=> [:ultra, :fast, :normal, :badspellers]</code></pre>
+
+If you need more documentation, you can check out the YARD files "on rdoc.info":http://rdoc.info/projects/freelancing-god/thinking-sphinx-raspell. This isn't a big library, though - what you see in this readme is pretty much what you get.
+
h2. Limitations
-* Currently only uses (and thus requires) the en_US dictionary.
-* Spelling suggestions are done via Raspell's normal mode, and are case insensitive.
* Only checks normal query strings, not field-specific queries via the @:conditions@ hash.
-Patches are very much welcome - I would like to address all of the above limitations.
+Patches are very much welcome - I would like to address this last remaining limitation.
h2. Copyright
Copyright (c) 2009 "Pat Allan":http://freelancing-gods.com. Released under an MIT licence.