Browse files

Update README

  • Loading branch information...
1 parent 33e730e commit 51d707c0f08f777f2db5374df08941afa7d2cf4c @binarylogic committed Jun 10, 2009
Showing with 15 additions and 0 deletions.
  1. +15 −0 README.rdoc
View
15 README.rdoc
@@ -2,8 +2,23 @@
<b>Searchlogic has been <em>completely</em> rewritten for v2. It is much simpler and has taken an entirely new approach. To give you an idea, v1 had ~2300 lines of code, v2 has ~350 lines of code.</b>
+<b>Attention v1 users. v2 breaks backwards compatibility. Please make sure your gem declaration for searchlogic looks like this so that you app does not break when the gem is updated: config.gem "searchlogic", :version => "~> 1.6.6"</b>
+
Searchlogic is a library that leverages named scopes to make searching in your application simple.
+== Install & use
+
+In your console:
+
+ sudo gem install searchlogic
+
+In your rails project:
+
+ # config/environment.rb
+ config.gem "searchlogic"
+
+That's it, you are ready to go. See below for usage examples.
+
== Search using conditions on columns
Instead of explaining what Searchlogic can do, let me show you. Let's start at the top:

0 comments on commit 51d707c

Please sign in to comment.