Skip to content

Commit

Permalink
fix: pin dependencies, clean-up readme docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bpevs committed Jul 7, 2022
1 parent 6df77b1 commit 6b5d6c9
Show file tree
Hide file tree
Showing 7 changed files with 22 additions and 16 deletions.
32 changes: 19 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,26 @@ Favioli is a tool for overriding Favicons for websites.

## Development

You need to download [Deno](https://deno.land/) in order to build this app.
### Quick Setup

After, we want to install [bext](https://github.com/bpevs/bext) (a set of browser extension build tools, types, and utilities for deno):
- Download [Deno](https://deno.land/)

```sh
deno install --bext -A https://deno.land/x/bext/main.ts # install bext packager
cd favioli # change directory to this repo
bext # run bext packager
# Unpacked extension output should be available in `dist/{browser}`
# You should be able to load your unpacked extension using a browser.
```

[bext](https://github.com/bpevs/bext) is a set of browser extension build tools, types, and utilities for deno. It was created for Favioli.

To load Favioli into a browser, point to each browser's respective dist directory.
[Google](https://developer.chrome.com/extensions) and
[Mozilla](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons) each have
resources about developing for their respective platforms.

If you want to install bext with more limited permissions:

```sh
deno install --name=bext --allow-read --allow-write --allow-run --allow-env -f https://deno.land/x/bext/main.ts
Expand All @@ -29,20 +46,9 @@ deno install --name=bext --allow-read --allow-write --allow-run --allow-env -f h
| `deno task test:all` | run code formatter, then unit tests |
| `deno task test:update` | run code formatter, then unit tests |

If you have bundled using make commands, you should be able to load your
unpacked extension using a browser.

This will build our distribution code into `/dist`, each browser with its own
directory. To load Favioli, point to each browser's respective directory.
[Google](https://developer.chrome.com/extensions) and
[Mozilla](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons) each have
resources about developing for their respective platforms.

## Inspiration

- [Emoji-Favicon-Toolkit](https://github.com/eligrey/emoji-favicon-toolkit) by
[OFTN Inc.](https://oftn.org) and [Eli Grey](https://eligrey.com)
- [eft-input-modified-indicator.js](https://gist.github.com/eligrey/4df9453c3bc20acd38728ccba7bb7160)
by [Eli Grey](https://eligrey.com)
- [Emoji-Selector](https://github.com/Kiricon/emoji-selector) by
[Dominic Valenicana](https://dominic.codes/)
6 changes: 3 additions & 3 deletions import_map.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
"imports": {
"browser": "https://deno.land/x/bext@v0.1.2/mod.ts",
"emoji": "https://deno.land/x/emoji@0.2.0/mod.ts",
"preact": "https://esm.sh/preact?dev",
"preact/hooks": "https://esm.sh/preact/hooks?dev",
"preact": "https://esm.sh/preact@10.9.0?dev",
"preact/hooks": "https://esm.sh/preact@10.9.0/hooks?dev",

"deno-dom": "https://deno.land/x/deno_dom@v0.1.32-alpha/deno-dom-wasm.ts",
"std/asserts": "https://deno.land/std@0.138.0/testing/asserts.ts",
"std/bdd": "https://deno.land/std@0.138.0/testing/bdd.ts",
"std/mock": "https://deno.land/std@0.138.0/testing/mock.ts",
"std/snapshot": "https://deno.land/std@0.138.0/testing/snapshot.ts",
"@testing-library/preact": "https://esm.sh/@testing-library/preact/pure?dev"
"@testing-library/preact": "https://esm.sh/@testing-library/preact@3.2.2/pure?dev"
}
}
Binary file removed static/screenshots/comparison.png
Binary file not shown.
Binary file removed static/screenshots/default.png
Binary file not shown.
Binary file removed static/screenshots/load-chrome-favioli.png
Binary file not shown.
Binary file removed static/screenshots/load-ff-favioli.png
Binary file not shown.
Binary file removed static/screenshots/overrides.png
Binary file not shown.

0 comments on commit 6b5d6c9

Please sign in to comment.