Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
squidfunk committed Mar 2, 2020
1 parent a531bf7 commit b6c3cd3
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Expand Up @@ -2,12 +2,22 @@

A tiny WebWorker polyfill for the `file://` protocol

Think [pseudo-worker][1] but using an `iframe` instead of `XMLHTTPRequest`.
This polyfill should be mostly spec-compliant and supports `importScripts`.
It should pretty much be a drop-in replacement.

## Installation

``` sh
npm install iframe-worker
```

## Usage

``` html
<script src="https://unpkg.com/iframe-worker"></script>
```

## License

**MIT License**
Expand All @@ -31,3 +41,5 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.

[1]: https://github.com/nolanlawson/pseudo-worker

0 comments on commit b6c3cd3

Please sign in to comment.