From c8826128550e8d85658460b22318061814206bf4 Mon Sep 17 00:00:00 2001 From: Kris Maglione Date: Sun, 6 Nov 2016 14:45:10 -0800 Subject: [PATCH] Update README and rename files to make it clearer that a build step is required. --- Gruntfile.js | 4 ++-- README.md | 15 +++++++++++++++ browser-polyfill.js => browser-polyfill.in.js | 0 3 files changed, 17 insertions(+), 2 deletions(-) rename browser-polyfill.js => browser-polyfill.in.js (100%) diff --git a/Gruntfile.js b/Gruntfile.js index 7f2465d..2b73734 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -13,7 +13,7 @@ module.exports = function(grunt) { pkg: grunt.file.readJSON("package.json"), eslint: { - src: ["browser-polyfill.js", "Gruntfile.js"], + src: ["browser-polyfill.in.js", "Gruntfile.js"], }, replace: { @@ -41,7 +41,7 @@ module.exports = function(grunt) { { expand: true, flatten: true, - src: ["browser-polyfill.js"], + src: ["browser-polyfill.in.js"], dest: "dist/", }, ], diff --git a/README.md b/README.md index b7628e4..1b6d8ac 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,21 @@ Chrome. [w3-browserext]: https://www.w3.org/community/browserext/ +## Building + +To build, assuming you're already installed [npm](https://www.npmjs.com/), +simply run: + +```sh +npm install +grunt +``` + +This will build both non-minified and minified versions of the final library, +and output them to `dist/browser-polyfill.js` and `dist/browser-polyfill.min.js`, +respectively. + + ## Basic Setup In order to use the polyfill, it must be loaded into any context where diff --git a/browser-polyfill.js b/browser-polyfill.in.js similarity index 100% rename from browser-polyfill.js rename to browser-polyfill.in.js