From a3bc791a19e3cabc0c34e0ba58a2aae344d02bf5 Mon Sep 17 00:00:00 2001 From: Jeremy Dormitzer Date: Thu, 15 Feb 2018 22:55:41 -0500 Subject: [PATCH] Document changes --- CHANGELOG.md | 6 ++++-- README.md | 8 +++++++- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e791d7e..107a577 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,13 +2,15 @@ All notable changes to this project will be documented in this file. This change log follows the conventions of [keepachangelog.com](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). ## [Unreleased] +### Changed +- Refactored the directory structure and build process to enable separate development and production resources. ## [1.1.2] ### Changed -- Revamped the whole build and package process to produce an artifact that meets Chrome and Firefox web store standards +- Revamped the whole build and package process to produce an artifact that meets Chrome and Firefox web store standards. ### Removed -- Removed unecessary permission requests and the custom CSP from the extension manifest, now that the build process enables that +- Removed unecessary permission requests and the custom CSP from the extension manifest, now that the build process enables that. ## [1.1.1] - 2018-02-06 ### Changed diff --git a/README.md b/README.md index 5130e5f..c81c024 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,16 @@ To build the source code once, navigate to the project root and run: $ make clean dev -This will output the generated JavaScript to `ext/js/generated`. +This will output the development build of the compiled extension to `ext`. The development build produces source maps and is significantly faster to compile. If you want a production build, run `make clean prod` instead. To load the extension locally in your browser, see [instructions for Firefox](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Temporary_Installation_in_Firefox) or [instructions for Chrome](https://developer.chrome.com/extensions/getstarted#unpacked). +To package the extension for publication, run: + + $ make package + +This will package a production build of the extension to `dist/looped-in.zip`. + ## License Copyright © 2018 Jeremy Dormitzer