Skip to content

Commit 4373b9e

Browse files
committed
Add Versions section to README
1 parent dceac22 commit 4373b9e

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
# node-XMLHttpRequest #
22

3-
node-XMLHttpRequest is a wrapper for the built-in http client to emulate the browser XMLHttpRequest object.
3+
node-XMLHttpRequest is a wrapper for the built-in http client to emulate the
4+
browser XMLHttpRequest object.
45

5-
This can be used with JS designed for browsers to improve reuse of code and allow the use of existing libraries.
6+
This can be used with JS designed for browsers to improve reuse of code and
7+
allow the use of existing libraries.
68

79
## Usage ##
8-
Here's how to include the module in your project and use as the browser-based XHR object.
10+
Here's how to include the module in your project and use as the browser-based
11+
XHR object.
912

1013
var XMLHttpRequest = require("xmlhttprequest").XMLHttpRequest;
1114
var xhr = new XMLHttpRequest();
@@ -15,6 +18,17 @@ case-sensitive systems (eg Linux) using uppercase letters won't work.
1518

1619
Refer to [W3C specs](http://www.w3.org/TR/XMLHttpRequest/) for XHR methods.
1720

21+
## Versions ##
22+
23+
Prior to 1.4.0 version numbers were arbitrary. From 1.4.0 on they conform to
24+
the standard major.minor.bugfix. 1.x shouldn't necessarily be considered
25+
stable just because it's above 0.x.
26+
27+
Since the XMLHttpRequest API is stable this library's API is stable as
28+
well. Major version numbers indicate significant core code changes.
29+
Minor versions indicate minor core code changes or better conformity to
30+
the W3C spec.
31+
1832
## Supports ##
1933

2034
* Async and synchronous requests

0 commit comments

Comments
 (0)