v0.0.1 - main functionality

.gitignore

@@ -13,3 +13,5 @@ results
 
 npm-debug.log
 node_modules
+.idea
+lib/esapi4js.js

README.md

@@ -1,2 +1,77 @@
-node-esapi
-==========
+[node-esapi](https://github.com/DeadAlready/node-esapi) is a minimal port of the ESAPI4JS (Enterprise Security API for JavaScript)
+encoder.
+
+# Installation
+
+    $ npm install node-esapi
+
+# Usage
+
+	var ESAPI = require('node-esapi');
+	ESAPI.encoder().encodeForHTML('<p>This is a test</p>');
+
+# Encoder Functions
+
+The encoder() returns an object with the following main functions:
+
++ encodeForHTML
++ encodeForCSS
++ encodeForJS = encodeForJavaScript = encodeForJavascript
++ encodeForURL
++ encodeForHTMLAttribute
++ encodeForBase64
+
+# Middleware
+
+The ESAPI has a function for creating express middleware to serve client side scripts of ESAPI.
+
+	app.use(ESAPI.middleware());
+
+	// Now in your HTML you can do
+	<script src="/esapi/esapi.js"></script>
+	<script src="/esapi/resources/i18n/ESAPI_Standard_en_US.properties.js"></script>
+	<script src="/esapi/resources/Base.esapi.properties.js"></script>
+	<script>
+		org.owasp.esapi.ESAPI.initialize();
+		//Here you have access to the $ESAPI object and can do
+		$ESAPI.encoder().encodeForHTML('<p>This is a test</p>');
+	</script>
+
+# Licence
+
+## ESAPI Licence
+
+The BSD License
+
+Copyright (c) 2007, The OWASP Foundation
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+Neither the name of the OWASP Foundation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+## node-esapi Licence
+
+The MIT License (MIT)
+
+Copyright (c) 2014 Karl Düüna
+
+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.