summaryrefslogtreecommitdiff
path: root/node_modules/socket.io-client/node_modules/xmlhttprequest/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/socket.io-client/node_modules/xmlhttprequest/README.md')
-rw-r--r--node_modules/socket.io-client/node_modules/xmlhttprequest/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/node_modules/socket.io-client/node_modules/xmlhttprequest/README.md b/node_modules/socket.io-client/node_modules/xmlhttprequest/README.md
new file mode 100644
index 0000000..70b8227
--- /dev/null
+++ b/node_modules/socket.io-client/node_modules/xmlhttprequest/README.md
@@ -0,0 +1,19 @@
+# node-XMLHttpRequest #
+
+node-XMLHttpRequest is arapper for the built-in http client to emulate the browser XMLHttpRequest object.
+
+This can be used with JS designed for browsers to improve reuse of code and allow the use of existing libraries.
+
+## Usage ##
+Here's how to include the module in your project and use as the browser-based XHR object.
+
+ var XMLHttpRequest = require("XMLHttpRequest").XMLHttpRequest;
+ var xhr = new XMLHttpRequest();
+
+Refer to W3C specs for XHR methods.
+
+## TODO ##
+
+* Add basic authentication
+* Additional unit tests
+* Possibly move from http to tcp for more flexibility