From 9f2b185c86682530dd900554a2c158a0418c2422 Mon Sep 17 00:00:00 2001 From: WindowsAurora <104532354+WindowsAurora@users.noreply.github.com> Date: Thu, 31 Oct 2024 16:59:09 +0100 Subject: [PATCH] Overhaul README --- README.md | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 1343fc1..abc316a 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,14 @@ # FMHYFilterlist FMHY Filterlist, Blocks unsafe and optionally also not recommended sites listed in [FMHY unsafe sites](https://fmhy.net/unsafesites). -> [!TIP] -> [Check out the website](https://fmhy.github.io/FMHYFilterlist/site/index.html) - > [!NOTE] > The "Basic" (recommended to use for inclusion in other blocklists or projects/browsers/etc.. as malicious sites filter, or for non-home network filtering) version blocks only the malicious sites, but the "Plus" (recommended to use for most users) version also blocks not recommended/potentially unsafe sites and apps ## How to use (Plus version) > [!NOTE] > Plus version of the filterlist blocks apps and websites like Avast/AVG/Avira/Opera/Kik Messenger/McAfee/CNet/Softonic, if you don't want these services to be blocked for some reason, use the "[Basic](#howtouse-basic)" version of the filterlist instead ### uBlock Origin (Easy): -1. [Go to the website](https://fmhy.github.io/FMHYFilterlist/site/index.html) -2. Click the "1 Click Install For Ublock Origin" button -3. Click the subscribe button +1. [Click Me](https://subscribe.adblockplus.org/?location=https://raw.githubusercontent.com/fmhy/FMHYFilterlist/main/filterlist.txt&title=FMHY%20Filterlist) +2. Click the subscribe button ### uBlock Origin (Manual) 1. Open ublock origin and select the cog ( to go to the dashboard ). 2. Click filter lists @@ -38,6 +34,9 @@ If your blocker doesn't support any of these formats, feel free to create an iss ## How to use (Basic version) > [!NOTE] > Basic version of the filterlist doesn't block apps and websites like Avast/AVG/Avira/Opera/Kik Messenger/McAfee/CNet/Softonic, if you do want services like this to be blocked, please use the "[Plus](#howtouse-plus)" version of the filterlist instead +### uBlock Origin (Easy): +1. [Click Me](https://subscribe.adblockplus.org/?location=https://raw.githubusercontent.com/fmhy/FMHYFilterlist/main/filterlist-basic.txt&title=FMHY%20Filterlist) +2. Click the subscribe button ### uBlock Origin (Manual) 1. Open ublock origin and select the cog ( to go to the dashboard ). 2. Click filter lists @@ -58,10 +57,20 @@ Blocklist formats: | Wildcard Domains | Main Link - `https://raw.githubusercontent.com/fmhy/FMHYFilterlist/main/filterlist-basic-wildcard-domains.txt`
Mirror - `https://fmhy.github.io/FMHYFilterlist/filterlist-basic-wildcard-domains.txt` | Wildcard URLs
uBlacklist | Main Link - `https://raw.githubusercontent.com/fmhy/FMHYFilterlist/main/filterlist-basic-wildcard-urls.txt`
Mirror - `https://fmhy.github.io/FMHYFilterlist/filterlist-basic-wildcard-urls.txt` +# FAQ: + ## How to contribute. Fork the project, add a website in sitelist.txt (or in sitelist-plus.txt if the domain fits in the Plus category) and run build.py then submit a pull request. -## Want to be a collaborator? +## Want to be a developer for the filterlist? + +Dm me in discord ( windowsaurora ) to request to be a collaborator this ensure the filterlist stays up to date if i can not update it. please note that you should have at least 1 pull request accepted to request being a collaborator. + +## Something is missing or broken in the FilterList. + +[Open a issue](https://subscribe.adblockplus.org/?location=https://raw.githubusercontent.com/fmhy/FMHYFilterlist/main/filterlist-basic.txt&title=FMHY%20Filterlist) + +## How do i contribute? -Dm me in discord ( windowsaurora ) to request to be a collaborator this ensure the filterlist stays up to date if i can not update it. please note that you should have at least 1 pull request accepted to request being a collaborator. \ No newline at end of file +Fork the project, add a website in sitelist.txt or sitelist-plus (Respectively) and run build.py then submit a pull request. \ No newline at end of file