Browse files

updated readme

  • Loading branch information...
1 parent ed3797f commit 0c8cc504b324d94764744f47986f2b7819d34f69 @theSmaw committed Oct 29, 2010
Showing with 4 additions and 7 deletions.
  1. +4 −7 README.rdoc
View
11 README.rdoc
@@ -1,17 +1,14 @@
-= <h2>Usage:</h2>
-=====================
-
-== Installation:
+== Installation
npm install sanitizer
-Require:
+== Require
var sanitizer = require('sanitizer');
-Use:
+== Use
sanitizer.escape('your dirty string'); // Escapes HTML special characters in attribute values as HTML entities
@@ -24,6 +21,6 @@ sanitizer.sanitize('your dirty string'); // Strips unsafe tags and attributes fr
exports.unescapeEntities('your string'); // The plain text of a chunk of HTML CDATA which possibly containing.
-More information:
+== More information
http://code.google.com/p/google-caja/source/browse/trunk/src/com/google/caja/plugin/html-sanitizer.js

0 comments on commit 0c8cc50

Please sign in to comment.