README.rdoc in glebtv-simple_captcha-0.2.1 vs README.rdoc in glebtv-simple_captcha-0.3.1

- old
+ new

@@ -1,8 +1,11 @@ =SimpleCaptcha -SimpleCaptcha is the simplest and a robust captcha plugin. Its implementation requires +This is a fork of wolcanus's fork of SimpleCaptcha to support Mongoid 3 and new formtastic. + +This is a fork of galetahub SimpleCaptcha to support Mongoid. +Its implementation requires adding up a single line in views and in controllers/models. SimpleCaptcha is available to be used with Rails 3 or above and also it provides the backward compatibility with previous versions of Rails. ==Features @@ -15,29 +18,30 @@ * Flexible DOM and CSS handling(There is a separate view partial for rednering SimpleCaptcha DOM elements). * Automated removal of 1 hour old unmatched simple_captcha data. ==Requirements -* {Ruby}[http://ruby-lang.org/] >= 1.9 +* {Ruby}[http://ruby-lang.org/] >= 1.8.7 * {Rails}[http://github.com/rails/rails] >= 3 * ImageMagick should be installed on your machine to use this plugin. visit http://www.imagemagick.org/script/index.php for more details. -* AR or mongoid ==Installation - gem "glebtv-simple_captcha", "~> 0.2.0", require: "simple_captcha" + gem "glebtv-simple_captcha", :require => "simple_captcha" +or + + gem 'glebtv-simple_captcha', :require => 'simple_captcha', :git => 'git://github.com/glebtv/simple-captcha.git' + ==Setup After installation, follow these simple steps to setup the plugin. The setup will depend on the version of rails your application is using. rails generate simple_captcha - rake db:migrate - ==Usage ===Controller Based Add the following line in the file "app/controllers/application.rb" @@ -161,18 +165,11 @@ SimpleCaptcha.setup do |sc| sc.image_magick_path = '/usr/bin' # you can check this from console by running: which convert end -You can provide the path where should be stored tmp files. -It's usefull when you dont have acces to /tmp (default directory) - SimpleCaptcha.setup do |sc| - sc.tmp_path = '/tmp' # or somewhere in project eg. Rails.root.join('tmp/simple_captcha').to_s, make shure directory exists - end - - ===How to change the CSS for SimpleCaptcha DOM elements? You can change the CSS of the SimpleCaptcha DOM elements as per your need in this file. /app/views/simple_captcha/_simple_captcha.erb ===View's Examples @@ -207,11 +204,11 @@ simple_captcha: message: default: "Secret Code did not match with the Image" user: "The secret Image and code were different" -==Who's who? +==The Original Author Enjoy the simplest captcha implementation. Author: Sur @@ -221,6 +218,6 @@ Plugin Homepage: http://expressica.com/simple_captcha Plugin update for rails 3: http://github.com/galetahub -Any feedback/comment/issue/donation is welcome! +Any feedback/comment/issue/donation is welcome! \ No newline at end of file