Let's try a release.

radiosilence · Mar 2, 2015 · 5b657d2 · 5b657d2
1 parent 78b3d1e
commit 5b657d2
Showing 1 changed file with 19 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,4 +1,22 @@
 xr
 ==
 
-Really simple wrapper about XR that provides a couple of nice functions, exposes the XHR object wherever relevant, and returns an ES6 Promise.
+Really simple wrapper about XR that provides a couple of nice functions,
+exposes the XHR object wherever relevant, and returns an ES6 Promise.
+
+API is simple, for now consult source files.
+
+Features
+--------
+
+ * Returns ES6 promises.
+ * Rejects if not 200.
+ * Has query parameter generation.
+ * Supports events.
+
+Requirements
+------------
+
+There must be a polyfill that supports at least the standard ES6 promise API
+(xr will use whatever's there), and Object.assign().
+