darkreader 4.9.58 → 4.9.67

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Dark Reader Ltd.
+Copyright (c) 2023 Dark Reader Ltd.
 
 All rights reserved.
 

package/README.md

@@ -20,15 +20,38 @@ Read more about contributing to Dark Reader in [CONTRIBUTING.md](https://github.
 
 ## Building for use
 
-You can install the extension from a file.  
-Install [Node.js LTS](https://nodejs.org/en/). Download the source code (or check out from git).  
+Dark Reader build script requires a JavaScript runtime, either NodeJS or Deno. We recommend using NodeJS, Deno support is experimental.
+
+### Building with NodeJS
+
+You can install the extension from a file.
+Install [Node.js](https://nodejs.org/) (we recommend LTS or higher, but any version at or above 15 will work). Download the source code (or check out from git).
 Open the terminal in the root folder and run:
 
 - `npm install`
-- `npm run build`
+- `npm run build` or `npm run build [-- flags]`
 
 This will create a `build/release/darkreader-chrome.zip` file for use in a Chromium-based browser and a `build/release/darkreader-firefox.xpi` file for use in Firefox.
 
+You can customize build process by passing flags to build script. To see all flags, run `npm run build -- --help`.
+
+### Building with Deno
+
+You can build Dark Reader with alternative runtime called [Deno](https://deno.land/). For this run `deno:bootstrap` script (e.g., via `npm run deno:bootstrap` or manually copy the command from `package.json`). Then run the same commands described above.
+
+Please note that if you encounter error `Too many open files (os error 24)`, then you should use the newer version of Deno (preferably built from source or canary).
+
+### Bundling with official Firefox store signatures (Experimental)
+
+Prior to publication, extension stores provide digital signatures for extensions. These digital signatures certify the integrity of the archive (that extension bundle did not get corrupted or bit-rotted) and that extension store preformed very basic extension validation.
+
+Dark Reader repository contains these digital signatures and you can add them to the extension bundle. The following will build Dark Reader for Firefox version 4.9.63:
+```
+npm run build -- --firefox --version=4.9.63
+```
+
+Please note that only Firefox Add-ons store signatures are present in the repositiry right now. Also, due to NodeJS and TypeScript version compatibility, one might have to first check out the old revision (commit), then build the extension files, then check out the recent commit and create the bundle (by running only `signature` and `zip` steps).
+
 ## Using Dark Reader for a website
 
 You can use Dark Reader to enable dark mode on your website!
@@ -37,7 +60,7 @@ You can use Dark Reader to enable dark mode on your website!
 - or build from the source code (`npm run api`)
 - or include the script via a CDN such as [unpkg](https://unpkg.com/darkreader/) or [jsDelivr](https://www.jsdelivr.com/package/npm/darkreader)
 
-Then you can use the following code to control Dark Reader's API
+Then you can use the following code to control Dark Reader's API:
 ```javascript
 DarkReader.enable({
     brightness: 100,
@@ -64,7 +87,7 @@ const CSS = await DarkReader.exportGeneratedCSS();
 const isEnabled = DarkReader.isEnabled();
 ```
 
-... or if you are using ES modules
+... or if you are using ES modules:
 
 ```javascript
 import {
@@ -90,7 +113,7 @@ const CSS = await collectCSS();
 const isEnabled = isDarkReaderEnabled();
 ```
 
-Be aware that darkreader will add the `chrome` object onto the `window` object. These are to stub certain functions that the code will use. They originate from the webextension-api.
+Be aware that Dark Reader will add the `chrome` object onto the `window` object. These are to stub certain functions that the code will use. They originate from the webextension-api.
 
 ## Site fixes
 
@@ -103,7 +126,7 @@ However, this can be enabled using the following steps:
 - Click on the Preview new design button.
 - Enable the `Synchronize site fixes` setting under `Settings -> Manage Settings`.
 
-To force a synchronization of the sites fixes (when the corresponding setting is enabled), use the following steps:
+To force a synchronization of the sites fixes (when the corresponding setting is enabled), perform the following steps:
 
 - Click on the Dark Reader icon.
 - Click on the Dev tools button (in the bottom-right corner).
@@ -124,7 +147,7 @@ To force a synchronization of the sites fixes (when the corresponding setting is
 <p align="center"><a rel="noreferrer noopener" href="https://opencollective.com/darkreader#backers" target="_blank"><img src="https://opencollective.com/darkreader/backers.svg?width=890&limit=1000"></a></p>
 
 <h2 align="center">Sponsors</h2>
-<p>Does your company use Dark Reader? Ask your manager or the marketing team if your company would be interested in supporting our project. Your support will allow the maintainers to dedicate more time to maintenance and creating new features for everyone. Also, your company's logo will show on <a rel="noreferrer noopener" href="https://github.com/darkreader/darkreader#sponsors" target="_blank">GitHub</a>. Who doesn't want a little extra exposure? <a rel="noreferrer noopener" href="https://opencollective.com/darkreader" target="_blank">Here's the info</a>.</p>
+<p>Does your company use Dark Reader? Please ask your manager or the marketing team if your company would be interested in supporting our project. Your support will allow the maintainers to dedicate more time to maintenance and creating new features for everyone. Also, your company's logo will show on <a rel="noreferrer noopener" href="https://github.com/darkreader/darkreader#sponsors" target="_blank">GitHub</a>. Who doesn't want a little extra exposure? <a rel="noreferrer noopener" href="https://opencollective.com/darkreader" target="_blank">Here's the info</a>.</p>
 
 <h3 align="center"><strong>Thank you to all our wonderful sponsors!</strong></h3>
 <br/>