Merge pull request #47 from greggawatt/patch-1

Update README.rdoc
jgarber · Mar 27, 2018 · dd7ee6c · dd7ee6c
2 parents 4808b36 + 5c9b35c
commit dd7ee6c
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/README.rdoc b/README.rdoc
@@ -171,6 +171,13 @@ Example:
 Will become:
 
  <acronym title="American Civil Liberties Union">ACLU</acronym>
+
+== Filtering HTML
+
+RedCloth doesn't filter unsafe html tags by default, do to this use the following syntax:
+  RedCloth.new("<script>alert(1)</script>", [:filter_html]).to_html
+which will filter the script tags from the HTML resulting in:
+  "&lt;script&gt;alert(1)&lt;/script&gt;"
 
 == Adding Tables