Commit Graph

14 Commits

Author SHA1 Message Date
serv-inc 34a6ab4559 docs(README): Add reminder to include browser-polyfill.js before other bg scripts (#160) 2018-11-08 15:09:14 +01:00
Mike Frysinger 450eee59a3 doc: fix broken link in README 2018-08-02 09:20:22 +02:00
Luca Greco e17f1e1763 chore: Fixed npm badge in README.md 2018-07-19 16:43:57 +02:00
Luca Greco 440857e5f8
doc: Rewrite README.md and move build and contribution details into a separate doc file (#147) 2018-07-19 15:56:49 +02:00
PoziWorld 33c2afb578 chore: Fixed typo in the README file (#143) 2018-07-07 17:43:17 +02:00
Federico Brigante 6f9cfdf6cf chore(README): Drop reference to babel for async/await (#50) 2018-04-09 19:24:15 +02:00
Rob Wu a7cbdcc23e fix: Use browser.storage.local in README (#87) (#90)
Applied fixed to all code snippets in README.md so that they are syntactically valid.
2018-03-19 15:42:40 +01:00
tmm88 390ccbf8b6 introducing table of contents
# Greetings

**the current PR does basically aim at:**
- *introducing table of contents*

---

**the motivation behind such a thing is basically to:**
- *improve accessability of the file*
2017-10-01 11:47:50 +01:00
Federico Brigante ab01b9605b docs: Added build status badge to the README.md (#45) 2017-08-20 13:35:53 +02:00
Luca Greco 31d778c2cd fix: Changes to the UMD built file and npm package publishing
This patch introduces on top of #17 some minor changes from the
review comments, in particular:

- do not replace require("../filename") to include the api-metadata.json
  (restored the original '{/* include("...") */}' placeholder)
- raise an appropriate error message when the source file is used
  by mistake (or the "dist/" file has not been built correctly).
- set the generated UMD wrapped module as the package.json main
  entrypoint
- do not include api-metadata.json and src dir from the files included
  in the published npm package
- run both build and test npm scripts on prepublish
2017-04-11 14:16:15 +02:00
Joseph Frazier f9248e62e7 feat: library wrapped as an UMD module
This addresses [issue 7] by making it possible for users to run:

```sh
npm install webextension-polyfill
```

and download a module that they can use with a bundler as follows:

```js
import browser from 'webextension-polyfill';
```

Also, add a [prepublish script] so that users who clone the repo don't
need to run `grunt` manually. In addition, specify [files] in
package.json so that this module can be published to npm without
including miscellanea. This can be verified by running:

```sh
npm pack && tar -tvf webextension-polyfill-0.1.0.tgz
```

[issue 7]: https://github.com/mozilla/webextension-polyfill/issues/7
[files]: https://docs.npmjs.com/files/package.json#files
[prepublish script]: https://docs.npmjs.com/misc/scripts
2017-04-11 13:32:31 +02:00
Kris Maglione c882612855 Update README and rename files to make it clearer that a build step is required. 2016-11-06 14:45:10 -08:00
Kris Maglione 2dd404db0f Add async function version of message listener example. 2016-10-10 14:03:27 -07:00
Kris Maglione c74d1af46d Initial checkin. 2016-10-10 11:36:21 -07:00