Skip to content

Commit

Permalink
Formatting README
Browse files Browse the repository at this point in the history
  • Loading branch information
adambair committed Jun 14, 2009
1 parent 750f5ef commit 1e2fa07
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.rdoc
Expand Up @@ -10,9 +10,8 @@ This plugin is provided as is - therefore, the creators and contributors of this

You can use it in your models:

Notice -- there are two profanity filters, one is destructive. Beware the exclamation point (profanity_filter!).

Non-Destructive (filters content when called, original text remains in the database)
Notice -- there are two profanity filters, one is destructive. Beware the exclamation point (profanity_filter!).
Non-Destructive (filters content when called, original text remains in the database)

profanity_filter :foo, :bar
# banned words will be replaced with @#$%
Expand All @@ -23,7 +22,7 @@ You can use it in your models:
some_model.foo => 'filtered version'
some_model.foo_original => 'non-filtered version'

Destructive (saves the filtered content to the database)
Destructive (saves the filtered content to the database)

profanity_filter! :foo, :bar
# banned words will be replaced with @#$%
Expand All @@ -41,7 +40,7 @@ You can also use the filter directly:
Inquiring minds can checkout the simple benchmarks I've included so you can have an idea of what kind of performance to expect. I've included some quick scenarios including strings of (100, 1000, 5000, 1000) words and dictionaries of (100, 1000, 5000, 25000, 50000, 100000) words.

You can run the benchmarks via:
/test/benchmark/fu-fu_benchmark.rb
ruby test/benchmark/fu-fu_benchmark.rb

== TODO

Expand Down

0 comments on commit 1e2fa07

Please sign in to comment.