diff --git a/README.md b/README.md new file mode 100644 index 0000000..f44f07a --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# AlwaysKillSticky + +A Chrome extension that automatically gets rid of sticky elements on websites you visit. + +## Installation + +* Download or clone this repository +* In Chrome, go to chrome://extensions (or Window menu -> Extensions, etc.) +* Enable Developer Mode by clicking the toggle switch at the top right +* Click the “Load Unpacked” button at the top left +* Select the AlwaysKillSticky folder + +AlwaysKillSticky should now be installed! + +However, 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. + +## Usage + +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”). + +AlwaysKillSticky can work in either two modes: **blacklist mode** and **whitelist mode**. + +In **blacklist mode** (the default), stickies will *only* be killed if: + +* the page URL matches one of the patterns in the **matching patterns** list, *and*; +* the page does *not* match any of the patterns in the **exclusion patterns** list. + +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. + +You can switch between blacklist mode and whitelist mode at any time. + +## License + +This extension is released under the GNU General Public License +as published by the Free Software Foundation; either version +2 of the License, or (at your option) any later version. diff --git a/manifest.json b/manifest.json index 7813cfe..3563c62 100644 --- a/manifest.json +++ b/manifest.json @@ -1,7 +1,10 @@ { + "manifest_version": 2, "name": "AlwaysKillSticky", "version": "0.2", "description": "Get rid of sticky elements on websites - permanently!", + "author": "Said Achmiz", + "homepage_url": "https://wiki.obormot.net/Main/AlwaysKillSticky", "permissions": [ "activeTab", "storage" ], "content_scripts": [ { @@ -10,6 +13,5 @@ "js": [ "contentScript.js" ] } ], - "options_page": "options.html", - "manifest_version": 2 + "options_page": "options.html" } \ No newline at end of file