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
   8
   9 * Install via the [Chrome web store](https://chrome.google.com/webstore/detail/alwayskillsticky/oolchklbojaobiipbmcnlgacfgficiig).
  10
  11 ### Firefox
  12
  13 * Install via [addons.mozilla.org](https://addons.mozilla.org/en-US/firefox/addon/alwayskillsticky/).
  14
  15 ### Opera
  16
  17 * [Download the latest release](https://wiki.obormot.net/Main/AlwaysKillSticky), or build from source (see below).
  18 * Unzip the package.
  19 * Go to `about://extensions` in the URL bar.
  20 * Enable Developer Mode by clicking the button (Opera).
  21 * Click the “Load Unpacked Extension” button.
  22 * Select the AlwaysKillSticky-chrome folder.
  23
  24 ### Building from source
  25
  26 You can build the extension from source, using the provided `build.php` script.
  27
  28 ### Post-installation
  29
  30 If you follow the above instructions, AlwaysKillSticky should now be installed!
  31
  32 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.
  33
  34 ## Usage
  35
  36 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”).
  37
  38 AlwaysKillSticky can work in either two modes: **blacklist mode** and **whitelist mode**.
  39
  40 In **blacklist mode** (the default), stickies will *only* be killed if:
  41
  42 * the page URL matches one of the patterns in the **matching patterns** list, *and*;
  43 * the page does *not* match any of the patterns in the **exclusion patterns** list.
  44
  45 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.
  46
  47 You can switch between blacklist mode and whitelist mode at any time.
  48
  49 ## License
  50
  51 This extension is released under the GNU General Public License
  52 as published by the Free Software Foundation; either version
  53 2 of the License, or (at your option) any later version.