Skip to content

Commit

Permalink
Overhaul README
Browse files Browse the repository at this point in the history
  • Loading branch information
WindowsAurora committed Oct 31, 2024
1 parent a5c9263 commit 9f2b185
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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) <a name="howtouse-plus"></a>
> [!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
Expand All @@ -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) <a name="howtouse-basic"></a>
> [!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
Expand All @@ -58,10 +57,20 @@ Blocklist formats:
| Wildcard Domains | Main Link - `https://raw.githubusercontent.com/fmhy/FMHYFilterlist/main/filterlist-basic-wildcard-domains.txt`<br>Mirror - `https://fmhy.github.io/FMHYFilterlist/filterlist-basic-wildcard-domains.txt`
| Wildcard URLs<br>uBlacklist | Main Link - `https://raw.githubusercontent.com/fmhy/FMHYFilterlist/main/filterlist-basic-wildcard-urls.txt`<br>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.
Fork the project, add a website in sitelist.txt or sitelist-plus (Respectively) and run build.py then submit a pull request.

0 comments on commit 9f2b185

Please sign in to comment.