Skip to content

Commit

Permalink
Updating README to add Firefox instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
alandtse committed Aug 15, 2018
1 parent 18551e6 commit 3085e49
Showing 1 changed file with 19 additions and 6 deletions.
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# spdx-diff

Diff selected text against SPDX licenses. Creates a browser button in Chrome to compare selected text against the SPDX [license list](https://spdx.org/licenses/).
Diff selected text against SPDX licenses. Creates a browser button in Chrome and Firefox to compare selected text against the SPDX [license list](https://spdx.org/licenses/).

![spdx-diff in action](app/images/spdx-diff.gif)

Expand All @@ -12,11 +12,24 @@ Diff selected text against SPDX licenses. Creates a browser button in Chrome to
## Usage

1. Build the extension
- Production: Run `$ gulp --production`
- Development: Run `$ gulp`
2. Load the `dist/chrome`-directory into chrome.
- Production:
- Chrome: Run `$ gulp pack`
- Firefox: Run `$ gulp pack --vendor firefox`
- Development:
- Chrome: Run `$ gulp`
- Firefox: Run `$ gulp --vendor firefox`

2. Load the extension:
- Chrome:
- Load `dist/chrome` directory using Load Unpacked.

![Extensions menu](https://developer.chrome.com/static/images/get_started/load_extension.png)
- Firefox:
- Enter "about:debugging" in the URL bar
- Click "Load Temporary Add-on"
- Load `dist/firefox/manifest.json`

[![Firefox Addons](https://img.youtube.com/vi/cer9EUKegG4/0.jpg)](https://www.youtube.com/watch?v=cer9EUKegG4)
# Making edits

## Entryfiles (bundles)
Expand All @@ -26,7 +39,7 @@ There are two kinds of entryfiles that create bundles when `gulp` is run.
1. All js-files in the root of the `./app/scripts` directory
2. All css-,scss- and less-files in the root of the `./app/styles` directory

The main logic is in <app/scripts/contentscript.js> and <app/scripts/worker.js>.
The main logic is in `/app/scripts/background.js`, `/app/scripts/contentscript.js` and `app/scripts/worker.js`.

## Tasks

Expand All @@ -37,7 +50,7 @@ The main logic is in <app/scripts/contentscript.js> and <app/scripts/worker.js>.

| Option | Description |
|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--watch` | Starts a livereload server and watches all assets. <br>To reload the extension on change include `livereload.js` in your bundle. |
| `--watch` | Starts a livereload server and watches all assets. <br>To reload the extension on change include `livereload.js` in your bundle. Chrome only. |
| `--production` | Minifies all assets |
| `--verbose` | Log additional data to the console. |
| `--vendor` | Compile the extension for different vendors (chrome, firefox, opera, edge) Default: chrome |
Expand Down

0 comments on commit 3085e49

Please sign in to comment.