Document changes

This commit is contained in:
Jeremy Dormitzer 2018-02-15 22:55:41 -05:00
parent fda8666a02
commit a3bc791a19
No known key found for this signature in database
GPG Key ID: 04F17C0F5A32C320
2 changed files with 11 additions and 3 deletions

View File

@ -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). 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] ## [Unreleased]
### Changed
- Refactored the directory structure and build process to enable separate development and production resources.
## [1.1.2] ## [1.1.2]
### Changed ### 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
- 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 ## [1.1.1] - 2018-02-06
### Changed ### Changed

View File

@ -17,10 +17,16 @@ To build the source code once, navigate to the project root and run:
$ make clean dev $ 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 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 ## License
Copyright © 2018 Jeremy Dormitzer Copyright © 2018 Jeremy Dormitzer