Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README how to: your own polyfill #5

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,18 @@ This package is available on npm as:
npm install xhr-promise
```

Then:

```
var XHRPromise = require('xhr-promise'); //Will require Promise polyfill Zousan (+ ~2kB)
```

or

```
var XHRPromise = require('xhr-promise/lib/xhr-promise'); //Use your own Promise polyfill
```

## Example

The xhr-promise code in this example does the same thing as the following XMLHttpRequest code.
Expand Down Expand Up @@ -95,4 +107,4 @@ $ grunt test

## License

MIT
MIT