mode-change on all files... + more documentation

grosser · Dec 29, 2008 · c5ed12d · c5ed12d
1 parent 945e4a9
commit c5ed12d
Show file tree

Hide file tree

Showing 43 changed files with 14 additions and 19 deletions.
diff --git a/.gitignore b/.gitignore
diff --git a/CHANGELOG b/CHANGELOG
diff --git a/MIT-LICENSE b/MIT-LICENSE
diff --git a/README b/README
@@ -1,16 +1,14 @@
 = search_do
-
-Library for fulltext search integration with active record using multiple backends.
-
-Supports:
-Hyper Estraier (http://hyperestraier.sourceforge.net/) an ActiveRecord model.
+* Library for fulltext search integration with active record.
+* Build to support multiple search Backends
+* acts_as_searchable Successor
 
 
 == Pre-requisites
 A working Hyper Estraier instance, setup instructions:
 
-* http://hyperestraier.sourceforge.net/nguide-en.html
-* http://pragmatig.wordpress.com/2008/05/06/getting-started-with-acts_as_searchable-on-ubuntu/
+* Setup Instructions: http://pragmatig.wordpress.com/2008/05/06/getting-started-with-acts_as_searchable-on-ubuntu/
+* In-depth Documentation: http://hyperestraier.sourceforge.net/nguide-en.html
 * rake search:node:create MODEL=User RAILS_ENV=production - for every model/environment you use
 
 
@@ -30,7 +28,6 @@ A working Hyper Estraier instance, setup instructions:
       :attributes => {:name=>nil,:city=>nil,:country=>nil,:age=>nil}
     )
     attr_accessor :html_snippet #add this to get html snippets on your results (see below)
-    attr_accessor :snippet #add this to get pure-snippets(not recommended) on your results
   end
 
   #SEARCH
@@ -41,7 +38,7 @@ A working Hyper Estraier instance, setup instructions:
    - sorted by age ASC
   @results = User.paginate_by_fulltext_search('hello',:attributes=>{:website=>'www',:age=>1},:order=>'age ASC',:page=>1,:per_page=>20)
 
-  (Same can be done without pagination magic: User.fulltext_search)
+  (Same can be done without pagination: User.fulltext_search)
 
   #SNIPPETS
   Each record found with a fulltext-search (not a attribute-only search) contains a snippet
@@ -50,17 +47,17 @@ A working Hyper Estraier instance, setup instructions:
   User.fulltext_search('hello') => user.html_snippet == "id like to say <b>hello</b> to my fellow students"
 
   NOTE: html_snippet will not contain HTML except for the <b>, so there is no need to escape it.
-
 
-== Bugtracking
-* fork and request pull
-* send a message http://github.com/moro
+
+== Hyperestraier Features
+ - Phrase search, regular expressions, attribute search, and similarity search
+ - Snippet retrival
+ - UTF8 support
+ - Web interface
+ - Built in P2P clustering of index servers
 
 
 == Origin
 Original is written by scoop see
 * http://github.com/scoop/acts_as_searchable/tree/master
-* http://poocs.net/2006/4/6/introducing-acts-as-searchable
-
-Another fork is maintained by MOROHASHI Kyosuke
-* http://github.com/moro/search_do/tree/master
+* http://poocs.net/2006/4/6/introducing-acts-as-searchable
diff --git a/Rakefile b/Rakefile
diff --git a/TESTING b/TESTING
diff --git a/TODO b/TODO
diff --git a/init.rb b/init.rb
diff --git a/install.rb b/install.rb
diff --git a/lib/estraier_admin.rb b/lib/estraier_admin.rb
diff --git a/lib/search_do.rb b/lib/search_do.rb
diff --git a/lib/search_do/backends.rb b/lib/search_do/backends.rb
diff --git a/lib/search_do/backends/hyper_estraier.rb b/lib/search_do/backends/hyper_estraier.rb
diff --git a/lib/search_do/backends/hyper_estraier/estraier_pure_extention.rb b/lib/search_do/backends/hyper_estraier/estraier_pure_extention.rb
diff --git a/lib/search_do/dirty_tracking.rb b/lib/search_do/dirty_tracking.rb
diff --git a/lib/search_do/dirty_tracking/bridge.rb b/lib/search_do/dirty_tracking/bridge.rb
diff --git a/lib/search_do/dirty_tracking/self_made.rb b/lib/search_do/dirty_tracking/self_made.rb
diff --git a/lib/search_do/indexer.rb b/lib/search_do/indexer.rb
diff --git a/lib/search_do/utils.rb b/lib/search_do/utils.rb
diff --git a/lib/vendor/estraierpure.rb b/lib/vendor/estraierpure.rb
diff --git a/lib/vendor/overview b/lib/vendor/overview
diff --git a/rails/init.rb b/rails/init.rb
diff --git a/recipes/mode_maintenance.rb b/recipes/mode_maintenance.rb
diff --git a/spec/backends/hyper_estraier_spec.rb b/spec/backends/hyper_estraier_spec.rb
diff --git a/spec/backends/result_document_spec.rb b/spec/backends/result_document_spec.rb
diff --git a/spec/dirty_tracking/bridge_spec.rb b/spec/dirty_tracking/bridge_spec.rb
diff --git a/spec/estraier_admin_spec.rb b/spec/estraier_admin_spec.rb
diff --git a/spec/fixtures/stories.yml b/spec/fixtures/stories.yml
diff --git a/spec/indexer_spec.rb b/spec/indexer_spec.rb
diff --git a/spec/search_do_spec.rb b/spec/search_do_spec.rb
diff --git a/spec/setup_test_model.rb b/spec/setup_test_model.rb
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
diff --git a/tasks/acts_as_searchable_tasks.rake b/tasks/acts_as_searchable_tasks.rake
diff --git a/test/abstract_unit.rb b/test/abstract_unit.rb
diff --git a/test/acts_as_searchable_test.rb b/test/acts_as_searchable_test.rb
diff --git a/test/database.yml b/test/database.yml
diff --git a/test/fixtures/article.rb b/test/fixtures/article.rb
diff --git a/test/fixtures/articles.yml b/test/fixtures/articles.yml
diff --git a/test/fixtures/comment.rb b/test/fixtures/comment.rb
diff --git a/test/fixtures/comments.yml b/test/fixtures/comments.yml
diff --git a/test/fixtures/notification.rb b/test/fixtures/notification.rb
diff --git a/test/fixtures/notifications.yml b/test/fixtures/notifications.yml
diff --git a/test/schema.rb b/test/schema.rb