Permalink
Browse files

Mention that this version has been deprecated

  • Loading branch information...
1 parent 59341ac commit 40e9c8a3b025ee956da7a326d6c1359b4c7981a1 @NZKoz committed May 24, 2010
Showing with 3 additions and 1 deletion.
  1. +3 −1 README.markdown
View
@@ -1,6 +1,8 @@
RailsXss
========
+__This Plugin is for rails 2.3.5, it will not work with later versions__. For all later versions you should be using the [rails/rails_xss](http://github.com/rails/rails_xss) version.
+
This plugin replaces the default ERB template handlers with erubis, and switches the behaviour to escape by default rather than requiring you to escape. This is consistent with the behaviour in Rails 3.0.
Strings now have a notion of "html safe", which is false by default. Whenever rails copies a string into the response body it checks whether or not the string is safe, safe strings are copied verbatim into the response body, but unsafe strings are escaped first.
@@ -82,7 +84,7 @@ This is intended functionality and can't be fixed.
Getting Started
===============
-1. Install rails 2.3.5 or higher, or freeze rails from 2-3-stable.
+1. Install rails 2.3.5 or 2.3.6
2. Install erubis (gem install erubis)
3. Install this plugin (ruby script/plugin install git://github.com/NZKoz/rails_xss.git)
4. Report anything that breaks.

0 comments on commit 40e9c8a

Please sign in to comment.