README.md

   1 # AlwaysKillSticky
   2
   3 A browser extension that automatically gets rid of sticky elements on websites you visit.
   4
   5 ## Installation
   6
   7 ### Chrome/Vivaldi/Opera
   8
   9 * [Download the latest release](https://wiki.obormot.net/Main/AlwaysKillSticky), or build from source (see below).
  10 * Unzip the package.
  11 * Go to `chrome://extensions` (Chrome), `vivaldi://extensions` (Vivaldi), or `about://extensions` (Opera) in the URL bar.
  12 * Enable Developer Mode by clicking the toggle switch (Chrome) / checkbox (Vivaldi) / button (Opera).
  13 * Click the “Load Unpacked” (or “Load Unpacked Extension”) button.
  14 * Select the AlwaysKillSticky-chrome folder.
  15
  16 ### Firefox
  17
  18 * Install via [addons.mozilla.org](https://addons.mozilla.org/en-US/firefox/addon/alwayskillsticky/).
  19
  20 ### Building from source
  21
  22 You can build the extension from source, using the provided `build.sh` script, passing the argument `chrome` (for Chrome, Opera, Vivaldi, etc.) or `firefox` (for Firefox & other Gecko-based browsers).
  23
  24 ### Post-installation
  25
  26 If you follow the above instructions, AlwaysKillSticky should now be installed!
  27
  28 Stickies will not be killed yet; you must now add some URLs to the **matching patterns** list (or, switch to **whitelist mode**); see **Usage**, below.
  29
  30 ## Usage
  31
  32 Open the AlwaysKillSticky options window (either by clicking on the AlwaysKillSticky icon in your toolbar, or by going to your Extensions page, clicking “Details”, then clicking “Extension options”).
  33
  34 AlwaysKillSticky can work in either two modes: **blacklist mode** and **whitelist mode**.
  35
  36 In **blacklist mode** (the default), stickies will *only* be killed if:
  37
  38 * the page URL matches one of the patterns in the **matching patterns** list, *and*;
  39 * the page does *not* match any of the patterns in the **exclusion patterns** list.
  40
  41 Conversely, in **whitelist mode**, the matching patterns list is *ignored*. Stickies are *always* killed, *unless* the page matches one of the patterns in the exclusion patterns list.
  42
  43 You can switch between blacklist mode and whitelist mode at any time.
  44
  45 ## License
  46
  47 This extension is released under the GNU General Public License
  48 as published by the Free Software Foundation; either version
  49 2 of the License, or (at your option) any later version.