update README.md

dinowang · Oct 11, 2018 · d17dc0d · d17dc0d
1 parent a7f1da4
commit d17dc0d
Showing 1 changed file with 13 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,13 @@
+# Problem and design
+
+Project you ASP.NET Core views to other site with zero effort.
+
+(TBC)
+
 # Usage
 
+## Add MiddlewareFilter attribute with ViewAsJavaScriptPipeline to your targeted action
+
 HomeController.cs
 
 `[MiddlewareFilter(typeof(ViewAsJavaScriptPipeline))]`
@@ -22,9 +30,9 @@ public class HomeController : Controller
 }
 ```
 
-Home\Index.cshtml
+## Render view with &lt;script&gt; tag and targeted action url
 
-`<script type="text/javascript" src="/Home/About"></script>`
+For example, include `<script type="text/javascript" src="/Home/About"></script>` in Home\Index.cshtml
 
 ```html
 @{
@@ -44,7 +52,9 @@ Home\Index.cshtml
 </div>
 ```
 
-Home/About as JavaScript
+## Result
+
+Home/About will render as JavaScript
 
 ```js
 document.write("<!DOCTYPE html>\n<html>\n<head>\n    <meta charset=\"utf-8\" />\n    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\n    <title>About - ViewAsScript</title>\n\n    \n        <link rel=\"stylesheet\" href=\"/lib/bootstrap/dist/css/bootstrap.css\" />\n        <link rel=\"stylesheet\" href=\"/css/site.css\" />\n    \n    \n</head>\n<body>\n    <nav class=\"navbar navbar-inverse navbar-fixed-top\">\n        <div class=\"container\">\n            <div class=\"navbar-header\">\n                <button type=\"button\" class=\"navbar-toggle\" data-toggle=\"collapse\" data-target=\".navbar-collapse\">\n                    <span class=\"sr-only\">Toggle navigation</span>\n                    <span class=\"icon-bar\"></span>\n                    <span class=\"icon-bar\"></span>\n                    <span class=\"icon-bar\"></span>\n                </button>\n                <a class=\"navbar-brand\" href=\"/\">ViewAsScript</a>\n            </div>\n            <div class=\"navbar-collapse collapse\">\n                <ul class=\"nav navbar-nav\">\n                    <li><a href=\"/\">Home</a></li>\n                    <li><a href=\"/Home/About\">About</a></li>\n                    <li><a href=\"/Home/Contact\">Contact</a></li>\n                </ul>\n            </div>\n        </div>\n    </nav>\n\n    \n\n\n\n    <div class=\"container body-content\">\n        <h2>About</h2>\n<h3>Your application description page.</h3>\n\n<p>Use this area to provide additional information.</p>\n\n        <hr />\n        <footer>\n            <p>&copy; 2018 - ViewAsScript</p>\n        </footer>\n    </div>\n\n    \n        <script src=\"/lib/jquery/dist/jquery.js\"></script>\n        <script src=\"/lib/bootstrap/dist/js/bootstrap.js\"></script>\n        <script src=\"/js/site.js?v=4q1jwFhaPaZgr8WAUSrux6hAuh0XDg9kPS3xIVq36I0\"></script>\n    \n    \n\n    \n</body>\n</html>\n");