Skip to content

Commit 26a5900

Browse files
Michael Oberwasserlechnerbjornstar
Michael Oberwasserlechner
authored andcommitted
Improve Readme (#3)
* docs(): add npm badges and installation info * docs(): improve readme * chore(): help github to pickup license information * Revert "chore(): help github to pickup license information"
1 parent ffa658c commit 26a5900

File tree

1 file changed

+29
-7
lines changed

1 file changed

+29
-7
lines changed

Diff for: README.md

+29-7
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,37 @@
1-
Blob.js
2-
==============
1+
# Blob Polyfill
32

4-
Blob.js implements the W3C [`Blob`][1] interface in browsers that do
5-
not natively support it.
3+
[![npm](https://img.shields.io/npm/v/blob-polyfill.svg)](https://www.npmjs.com/package/blob-polyfill)
4+
[![npm](https://img.shields.io/npm/dm/blob-polyfill.svg)](https://www.npmjs.com/package/blob-polyfill)
65

7-
Supported browsers
8-
------------------
6+
## Purpose
7+
8+
Blob Polyfill serves [Blob.js][0] over npm.
9+
10+
Blob.js implements the W3C [`Blob`][1] interface in browsers that do not natively support it.
11+
12+
## Changelog
13+
14+
[Please read the changelog](CHANGELOG.md)
15+
16+
## Installation
17+
18+
To install this library, run:
19+
20+
```bash
21+
$ npm install blob-polyfill --save
22+
```
23+
24+
25+
## Supported browsers
926

1027
Blob.js shares the [same supported browsers as FileSaver.js][2].
1128

29+
## License
30+
31+
[MIT](LICENSE.md)
32+
1233
![Tracking image](https://in.getclicky.com/212712ns.gif)
1334

35+
[0]: https://github.com/eligrey/Blob.js
1436
[1]: https://developer.mozilla.org/en-US/docs/Web/API/Blob
15-
[2]: https://github.com/eligrey/FileSaver.js#supported-browsers
37+
[2]: https://github.com/eligrey/FileSaver.js#supported-browsers

0 commit comments

Comments
 (0)