Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Eskander authored Aug 12, 2019
1 parent 3fda0d3 commit 3f990cb
Showing 1 changed file with 19 additions and 11 deletions.
30 changes: 19 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Ultra Popup Blocker
Ultra Popup Blocker (or UPB for short) is a lightweight Popup Blocker that aims to *radically* block **all popup windows** by default, (even good, unharmful, user-initiated ones) while giving users control to allow popups temporarily or permanently via a whitelisting mechanism.
Ultra Popup Blocker (or UPB for short) is a lightweight Popup Blocker that aims to *radically* block **all popup windows** by default, (even good, unharmful, user-initiated ones) while giving users control to allow popups temporarily or permanently via a [whitelisting mechanism][whtlstid].

<p align="center"><img src="https://raw.githubusercontent.com/Eskander/ultra-popup-blocker/master/screenshots/bottom-bar.png"></p>

### Why another popup blocker?

Built-in Firefox and Chrome popup blockers blocks only the popups that were created automatically via script on page load etc. When you click on a button on the page, it won't block it.
However, malicious websites can create JS code that will launch the popups whenever you click on any blank space on the page for instance.

Expand All @@ -12,18 +12,26 @@ In JavaScript, functions are first-order citizens. It means you can store a func
Here, we override 'window.open' with our own implementation which prompts the user to see whether he really wants to open a popup window.
#### Tests: http://www.popuptest.com/

### Managing whitelisted domains
Use the dynamic list provided with Ultra Popup Blocker to manage which websites are allowed to open popups freely.

<p align="center"><img src="https://raw.githubusercontent.com/Eskander/ultra-popup-blocker/master/screenshots/whitelist-config.png"></p>

### Install instructions
1. Get a userscript manager from your browser's addon store. I personally use [Tampermonkey on Firefox ➚][ext].
2. Add **Ultra Popup Blocker** from one of the following sources:

# [![GreasyFork][b1]][l1] [![OpenUserJS][b2]][l2] [![GitHub][b3]][l3]
# [![GreasyFork][button1]][link1] [![OpenUserJS][button2]][link2] [![GitHub][button3]][link3]

[ext]: https://addons.mozilla.org/en-US/firefox/addon/tampermonkey/

[b1]: https://img.shields.io/badge/Install-GreasyFork-red.svg?longCache=true&style=for-the-badge&
[b2]: https://img.shields.io/badge/Install-OpenUserJS-blue.svg?longCache=true&style=for-the-badge
[b3]: https://img.shields.io/badge/Install-GitHub-lightgrey.svg?longCache=true&style=for-the-badge

[l1]: https://greasyfork.org/en/scripts/387937-ultra-popup-blocker
[l2]: https://openuserjs.org/scripts/eskander/Ultra_Popup_Blocker
[l3]: https://github.com/Eskander/ultra-popup-blocker/raw/master/ultra-popup-blocker.user.js
[whtlstid]: #managing-whitelisted-domains

[button1]: https://img.shields.io/badge/Install-GreasyFork-red.svg?longCache=true&style=for-the-badge&
[link1]: https://greasyfork.org/en/scripts/387937-ultra-popup-blocker

[button2]: https://img.shields.io/badge/Install-OpenUserJS-blue.svg?longCache=true&style=for-the-badge
[link2]: https://openuserjs.org/scripts/eskander/Ultra_Popup_Blocker

[button3]: https://img.shields.io/badge/Install-GitHub-lightgrey.svg?longCache=true&style=for-the-badge
[link3]: https://github.com/Eskander/ultra-popup-blocker/raw/master/ultra-popup-blocker.user.js

0 comments on commit 3f990cb

Please sign in to comment.