Skip to content

Commit be1e2a0

Browse files
committed
Update readme, bump version to 1.4.0
1 parent 34f2f16 commit be1e2a0

File tree

2 files changed

+18
-10
lines changed

2 files changed

+18
-10
lines changed

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@ browser XMLHttpRequest object.
66
This can be used with JS designed for browsers to improve reuse of code and
77
allow the use of existing libraries.
88

9+
Note: This library currently conforms to [XMLHttpRequest 1](http://www.w3.org/TR/XMLHttpRequest/). Version 2.0 will target [XMLHttpRequest Level 2](http://www.w3.org/TR/XMLHttpRequest2/).
10+
911
## Usage ##
12+
1013
Here's how to include the module in your project and use as the browser-based
1114
XHR object.
1215

@@ -16,8 +19,6 @@ XHR object.
1619
Note: use the lowercase string "xmlhttprequest" in your require(). On
1720
case-sensitive systems (eg Linux) using uppercase letters won't work.
1821

19-
Refer to [W3C specs](http://www.w3.org/TR/XMLHttpRequest/) for XHR methods.
20-
2122
## Versions ##
2223

2324
Prior to 1.4.0 version numbers were arbitrary. From 1.4.0 on they conform to
@@ -33,13 +34,20 @@ the W3C spec.
3334

3435
* Async and synchronous requests
3536
* GET, POST, PUT, and DELETE requests
36-
* All native methods (open, send, abort, getRequestHeader,
37-
getAllRequestHeaders)
37+
* All spec methods (open, send, abort, getRequestHeader,
38+
getAllRequestHeaders, event methods)
3839
* Requests to all domains
3940

40-
## TODO ##
41+
## Known Issues / Missing Features ##
42+
43+
For a list of open issues or to report your own visit the [github issues
44+
page](https://github.com/driverdan/node-XMLHttpRequest/issues).
4145

42-
* Add basic authentication
43-
* Additional unit tests
44-
* Possibly move from http to tcp for more flexibility
45-
* XML parsing
46+
* Local file access may have unexpected results for non-UTF8 files
47+
* Synchronous requests don't set headers properly
48+
* Synchronous requests freeze node while waiting for response (But that's what you want, right? Stick with async!).
49+
* Some events are missing, such as abort
50+
* getRequestHeader is case-sensitive
51+
* Cookies aren't persisted between requests
52+
* Missing XML support
53+
* Missing basic auth

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "xmlhttprequest"
33
, "description": "XMLHttpRequest for Node"
4-
, "version": "1.3.0"
4+
, "version": "1.4.0"
55
, "author": {
66
"name": "Dan DeFelippi"
77
, "url": "http://driverdan.com"

0 commit comments

Comments
 (0)