diff --git a/.npmignore b/.npmignore
index 166b8e8..3a5ca5b 100644
--- a/.npmignore
+++ b/.npmignore
@@ -1,7 +1,7 @@
*~
.babelrc
-.eslintrc
.eslintignore
+.eslintrc
.nyc_output
.prettierrc
.travis.yml
@@ -9,6 +9,7 @@ bench
bower.json
coverage
docs
+klipse-github-docs.config.js
rollup.config.js
scripts
test
diff --git a/README.md b/README.md
index 58021f9..d783615 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# Karet XHR
+
+ Please wait... The interactive code snippets on this page take a moment to render.
+
+
+
+ All the code snippets on this page are live and interactive
+ powered by the klipse
+ plugin .
+
+ Karet XHR ·
+This library provides a thin wrapper over the standard
+XMLHttpRequestKefir
+properties . The benefit
+of this approach is that it makes it easy to implement many kinds of use cases
+ranging from just getting the response data to visualizing the progress of
+ongoing upload and/or download and displaying potential errors. See also Karet
+FR .
+Examples:
+
+The Giphy CodeSandbox uses this library
+to do simple JSON GET requests.
+The GitHub repository search
+CodeSandbox uses this library to do JSON GET requests and exercises much of
+the API of this library as an example.
+
+
+≡ ■ Contents≡ ■ ReferenceThe interface of this library consists of named exports. Typically one just
+imports the library as:
+import * as XHR from 'karet.xhr'Using this library, one first creates an observable property
+representing the state of an
+XMLHttpRequestXHR.performoverall , download ,
+and upload state.
+
+
+XHR.getJson(arg) is shorthand for
+XHR.responseFull(XHR.performJson(arg))XHR.performJson
+
+XHR.performJson is shorthand for XHR.performWith({responseType:
+'json'})
+
+XHR.performWith is a curried function that allows one to define a
+XHR.performXHR.perform
+For example:
+var get = XHR.performWith({responseType: 'json', timeout: 30*1000})
+// ...
+get(url)XHR.perform creates an observable
+property that represents
+the state of an ongoing
+XMLHttpRequestaborted
+in case the property is fully unsubscribed from before it has ended. See also
+XHR.performWith
+Only the url parameter is required and can be passed as a string. Other
+parameters have their XHR default values:
+
+
+
+Parameter
+Default
+Explanation
+
+
+
+method'GET'HTTP request method to use.
+
+usernullUser name for authentication.
+
+
+passwordnullPassword for authentication.
+
+
+headersnullAn array of [header, value] pairs, a plain object of {header: value} properties, a MapHeaders
+
+
+overrideMimeTypeundefinedIf specified overrides the MIME type provided by the server.
+
+
+bodynullA body of data to be sent.
+
+
+responseType''Specifies type of response data.
+
+
+timeout0Number of milliseconds or 0 for infinite.
+
+
+withCredentialsfalseWhether cross-site Access-Control should use credentials.
+
+
+In addition to a plain object, the argument to XHR.perform is allowed to be an
+observable property or contain observable properties, in which case the property
+created by XHR.perform performs the XHR with the
+latest argument values.
+Note that typically one does not explicitly subscribe to the property, but one
+rather computes a desired view of the property, such as a view of the
+response , and combines that further into some more interesting
+property.
+WARNING: Setting responseType to 'json' is not supported by IE 11. This
+library implements a workaround by calling JSON.parse on the returned data in
+case setting responseType to 'json' fails. In case the response does not
+parse, then XHR.responseXHR.responseFullnull.
+See this live GitHub repository search
+CodeSandbox for an example.
+
+
+XHR.allResponseHeaders returns a possibly observable property that emits the
+value of
+getAllResponseHeaders()readyState must be 2Error will be thrown.
+
+XHR.headersReceived returns a possibly observable boolean property that tells
+whether HTTP headers have been received and can be obtained using
+XHR.allResponseHeadersXHR.responseHeader
+
+XHR.isDone returns a possibly observable boolean property that tells whether
+the XHR operation is complete (whether success or failure).
+
+XHR.readyState returns a possibly observable property of the
+readyState
+
+XHR.response returns a possibly observable property of the
+responseXHR.responseFull
+
+XHR.responseFull returns a possibly observable property that emits the
+responsereadyState must be 4Error will be thrown. See also
+XHR.response
+
+XHR.responseHeader returns a possibly observable property that emits the value
+of
+getResponseHeader(header)header after the HTTP headers have been received. When called
+on a non-observable XHR, its readyState must be 2Error will be thrown.
+
+XHR.responseText returns a possibly observable property of the
+responseText
+
+XHR.responseType returns a possibly observable property of the
+responseType
+
+XHR.responseURL returns a possibly observable property of the
+responseURL
+
+XHR.responseXML returns a possibly observable property of the
+responseXML
+
+XHR.status returns a possibly observable property of the
+status
+
+XHR.statusIsHttpSuccess(xhr) is shorthand for
+XHR.isHttpSuccess(XHR.status(xhr)). See also XHR.statusXHR.isHttpSuccess
+
+XHR.statusText returns a possibly observable property of the
+statusText
+
+XHR.timeout returns a possibly observable property of the
+timeout
+
+XHR.withCredentials returns a possibly observable property of the
+withCredentials
+
+
+XHR.downError returns a possibly observable property of the
+error
+
+XHR.downHasEnded returns a possibly observable boolean property that tells
+whether the download operation of an ongoing XHR has
+ended .
+
+XHR.downHasFailed returns a possibly observable boolean property that tells
+whether the download operation of an ongoing XHR has
+failed .
+
+XHR.downHasStarted returns a possibly observable boolean property that tells
+whether the download operation of an ongoing XHR has
+started .
+
+XHR.downHasSucceeded returns a possibly observable boolean property that tells
+whether the download operation of an ongoing XHR has
+succeeded . Note
+that this does not take into account the HTTP response status, see
+XHR.statusXHR.isHttpSuccess
+
+XHR.downHasTimedOut returns a possibly observable boolean property that tells
+whether the download operation of an ongoing XHR has timed
+out .
+
+XHR.downIsProgressing returns a possibly observable boolean property that
+tells whether the download operation of an ongoing XHR is
+progressing .
+
+XHR.downLoaded returns a possibly observable property of the
+loaded
+
+XHR.downTotal returns a possibly observable property of the
+total
+
+
+XHR.upError returns a possibly observable property of the
+error
+
+XHR.upHasEnded returns a possibly observable boolean property that tells
+whether the upload operation of an ongoing XHR has
+ended .
+
+XHR.upHasFailed returns a possibly observable boolean property that tells
+whether the upload operation of an ongoing XHR has
+failed .
+
+XHR.upHasStarted returns a possibly observable boolean property that tells
+whether the upload operation of an ongoing XHR has
+started .
+
+XHR.upHasSucceeded returns a possibly observable boolean property that tells
+whether the upload operation of an ongoing XHR has
+succeeded . Note
+that this does not take into account the HTTP response status, see
+XHR.statusXHR.isHttpSuccess
+
+XHR.upHasTimedOut returns a possibly observable boolean property that tells
+whether the upload operation of an ongoing XHR has timed
+out .
+
+XHR.upIsProgressing returns a possibly observable boolean property that tells
+whether the upload operation of an ongoing XHR is
+progressing .
+
+XHR.upLoaded returns a possibly observable property of the
+loaded
+
+XHR.upTotal returns a possibly observable property of the
+total
+
+
+XHR.isHttpSuccess returns a possibly observable property of whether the given
+numeric property is in the range 2xx of HTTP success
+codes .
+See also XHR.statusIsHttpSuccess
+
+
+
+ document.querySelector('.loading-message').className = "loading-hidden";
+ ga('send', 'event', 'completed', 'load', Math.round((Date.now() - startTime)/1000));
+ accelerate_klipse();
+
+
+
+
+
+