From 06cef115b047660f8fc7c8c3d5abb85ca5e5e677 Mon Sep 17 00:00:00 2001
From: "Jackson.Bruce" <Jackson.bruce@live.com>
Date: Mon, 16 Mar 2020 01:49:06 +0800
Subject: [PATCH] Update README.md

---
 README.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 53 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 8791b69..b13977a 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,54 @@
 # AntiXssUF
-xss anti
+跨站脚本攻击（XSS）过滤器，以白名单的过滤策略，支持多种过滤策略，可以根据业务场景选择适合的过滤策略，或者根据用户角色动态绑定过滤策略，支持OwaspAntisamy项目的配置，支持json格式的配置；
+使用方法：
+
+        public void ConfigureServices(IServiceCollection services)
+        {
+            //添加策略和设置默认策略
+            services.AddXssFilter(opt=>opt.DefaultSchemeName= "DefaultPolicy")
+                .AddScheme<AntisamyPolicy>("antisamy", () => File.ReadAllTextAsync(Path.Combine(HostEnvironment.ContentRootPath, "resources/antisamy.xml")))
+                .AddScheme<AntisamyPolicy>("anythinggoes", () => File.ReadAllTextAsync(Path.Combine(HostEnvironment.ContentRootPath, "resources/antisamy-anythinggoes.xml")))
+                .AddScheme<AntisamyPolicy>("ebay", () => File.ReadAllTextAsync(Path.Combine(HostEnvironment.ContentRootPath, "resources/antisamy-ebay.xml")))
+                .AddScheme<AntisamyPolicy>("myspace", () => File.ReadAllTextAsync(Path.Combine(HostEnvironment.ContentRootPath, "resources/antisamy-myspace.xml")))
+                .AddScheme<AntisamyPolicy>("slashdot", () => File.ReadAllTextAsync(Path.Combine(HostEnvironment.ContentRootPath, "resources/antisamy-slashdot.xml")))
+                .AddScheme<AntisamyPolicy>("test", () => File.ReadAllTextAsync(Path.Combine(HostEnvironment.ContentRootPath, "resources/antisamy-test.xml")))
+                .AddScheme<JsonFilterPolicy>("DefaultPolicy", () => File.ReadAllTextAsync(Path.Combine(HostEnvironment.ContentRootPath, "resources/DefaultPolicy.json")));
+            ;
+            //添加模型绑定器
+            services.AddControllers(options =>
+            {
+                options.ModelBinderProviders.Insert(0, new RichTextBinderProvider());
+            });
+            services.AddControllersWithViews();
+        }
+        //依赖注入
+        public HomeController(IFilterPolicyFactory policyFactory)
+        {
+            this.policyFactory = policyFactory;
+        }
+        public async Task<IActionResult> Test(string source) {
+            var policyName="ebay"//策略名称
+            var filter=await policyFactory.CreateHtmlFilter(policyName);//创建过滤器
+            var clean = filter.Filters(source);//过滤危险代码
+            return Content(clean);
+        }
+        //模型绑定过滤策略
+        public class TestModel
+        {
+           public string Name { get; set; }
+            [XssSchemeName("ebay")]
+            public RichText RichText { get; set; }
+        }
+        public IActionResult Test(TestModel model)
+        {
+            string clean = model?.RichText;//这里自动过滤危险代码
+            return Content(clean??string.Empty);
+        }
+        //使用参数绑定过滤策略
+        public IActionResult Test([XssSchemeName("ebay")] RichText richText)
+        {
+            string clean = richText;//这里自动过滤危险代码
+            return Content(clean??string.Empty);
+        }
+        
+