README

MIT-License

@@ -0,0 +1,23 @@
+Copyright (c) 2012 Lei Zongmin(雷宗民) <leizongmin@gmail.com>
+http://ucdok.com
+
+The MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,4 +1,57 @@
-js-xss
+过滤XSS攻击
 ======
 
-过滤XSS攻击
+## 安装
+
+**npm install xss**
+
+
+## 使用方法：
+
+```javascript
+var xss = require('xss');
+// 使用默认的HTML白名单
+console.log(xss('<script>alert("fff");</script>'));
+// 指定HTML白名单
+var whiteList = {
+	tag: ['attribute1', 'attribute2']	// 允许的属性
+};
+console.log(xss('<script>alert("fff");</script>', whiteList));
+// 请参考默认的白名单：xss.whiteList
+```
+
+
+## 测试
+
+**npm test**
+
+
+## 授权协议
+
+基于MIT协议发布：
+
+```
+Copyright (c) 2012 Lei Zongmin(雷宗民) <leizongmin@gmail.com>
+http://ucdok.com
+
+The MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+```

package.json

@@ -0,0 +1,20 @@
+{
+  "name":           "xss",
+  "main":           "./index.js",
+  "version":        "0.0.1",
+  "description":    "Remove XSS attack vectors from user-supplied HTML",
+  "author":         "leizongmin <leizongmin@gmail.com> (http://ucdok.com)",
+  "repository": {
+    "type": "git",
+    "url":  "git://github.com/leizongmin/js-xss.git"
+  },
+  "engines": {
+    "node":         ">= 0.6.0"
+  },
+  "devDependencies": {
+    "mocha":        ">= 1.2"
+  },
+  "scripts": {
+    "test":         "mocha -t 5000"
+  }
+}