FMHY-SafeGuard/README.md

<p align="center">
  <a href="https://github.com/fmhy/FMHY-SafeGuard/releases"><img src="https://github.com/fmhy/FMHY-SafeGuard/blob/main/assets/banner.png" /></a>
</p>
<div align="center">
  <a href="https://github.com/fmhy/FMHY/wiki/FMHY-Discord">
    <img src="https://img.shields.io/static/v1?label=Join&message=FMHY&color=c4b5fd" alt="Invite Link"></a>
  <a href="https://github.com/fmhy/FMHY-SafeGuard/commits/main/">
    <img src="https://img.shields.io/github/last-commit/fmhy/FMHY-SafeGuard?label=Last%20Commit&color=green" alt="Last Commit"></a>
  <a href="https://github.com/v/FMHY-SafeGuard/blob/main/LICENSE">
    <img src="https://img.shields.io/github/license/fmhy/FMHY-SafeGuard" alt="GitHub License"></a>
</div>
<br>
<h2> <div align="center"><b> Protect Your Browsing with FMHY SafeGuard: Easy Filterlist Integration. </b></div> </h2>

# 🛡️ What is FMHY SafeGuard?

**FMHY SafeGuard** is a browser extension that keeps you safe by checking websites against the latest filterlists from [FMHY Filterlist](https://github.com/fmhy/FMHYFilterlist). The extension categorizes websites as starred, safe, unsafe, or potentially dangerous, giving you peace of mind while browsing.

<p align="center">
  <img src="https://github.com/fmhy/FMHY-SafeGuard/blob/main/assets/header.png" style="width: 300px">
</p>

<div align="center">
  <table>
    <tr>
      <td><img src="https://github.com/fmhy/FMHY-SafeGuard/blob/main/assets/icons/default.png" style="width: 144px"></td>
      <td><img src="https://github.com/fmhy/FMHY-SafeGuard/blob/main/assets/icons/starred.png" style="width: 144px"></td>
      <td><img src="https://github.com/fmhy/FMHY-SafeGuard/blob/main/assets/icons/safe.png" style="width: 144px"></td>
      <td><img src="https://github.com/fmhy/FMHY-SafeGuard/blob/main/assets/icons/potentially_unsafe.png" style="width: 144px"></td>
      <td><img src="https://github.com/fmhy/FMHY-SafeGuard/blob/main/assets/icons/unsafe.png" style="width: 144px"></td>
    </tr>
    <tr>
      <td>Not in Wiki</td>
      <td>Starred</td>
      <td>Safe</td>
      <td>Potentially Unsafe</td>
      <td>Unsafe</td>
    </tr>
  </table>
</div>

***

<p align="center">
  <a href="https://addons.mozilla.org/en-US/firefox/addon/fmhy-safeguard/"><img src="https://github.com/fmhy/FMHY-SafeGuard/blob/main/assets/firefox_addon_image.png" alt="Get FMHY SafeGuard for Firefox"></a>
  <a href="https://chromewebstore.google.com/detail/fmhy-safeguard/ihcppnlmkfeclmehgdhjkglkbmiemnmp"><img src="https://github.com/fmhy/FMHY-SafeGuard/blob/main/assets/chrome_addon_image.png" alt="Get FMHY SafeGuard for Chrome"></a>
</div>

***

# 🌟 Key Features
- **Real-time Site Status**: Instant feedback on whether a site is starred, safe, unsafe, or potentially unsafe, with visual toolbar icons.
- **Updated Filterlists**: Utilizes the frequently updated FMHY filterlist to ensure protection from the latest unsafe domains.
- **Pop-up Alerts**: Get easy-to-read pop-ups that inform you about the site status and allow further action.
- **Search Engine-Focused Highlighting**: Seamlessly highlights links on search engines with colors and icons, instantly showing if a site is safe, unsafe, or potentially dangerous.
- **FMHY Notes**: View relevant notes from the FMHY wiki when visiting mapped websites with 80+ domain mappings.
- **Unsafe Site Reasons**: See exactly why a site is flagged as unsafe with detailed reasons and clickable evidence links.
- **Site Passwords & Invite Codes**: Automatically displays passwords or invite codes for sites that require them, with easy click-to-copy functionality.
- **Multi-Language Support**: Available in 7 languages: English, Spanish, Russian, German, Portuguese, French, and Japanese.
- **Theme Options**: Beautiful dark, light, and AMOLED themes with system preference detection.

# 📋 Usage Instructions

1. **Install the Extension**: Install FMHY SafeGuard from the [Releases Page](https://github.com/fmhy/FMHY-SafeGuard/releases) or the [Firefox page](https://addons.mozilla.org/en-US/firefox/addon/fmhy-safeguard/)/[Chrome Page](https://chromewebstore.google.com/detail/fmhy-safeguard/ihcppnlmkfeclmehgdhjkglkbmiemnmp).
2. **Browse Securely**: Visit any website and the toolbar icon will automatically update to reflect the site’s safety status (Starred, Safe, Unsafe, Potentially Unsafe).
3. **View More Info**: Click the extension icon to open a popup with detailed site status information, including a link to contribute or report unknown sites (Coming soon!).

# 🔒 Why Choose FMHY SafeGuard?

- **Up-to-date Protection**: Always uses the latest FMHY filterlist to block unsafe or malicious websites.
- **Clean User Interface**: Simple, non-intrusive design to help you stay informed without cluttering your browsing experience.
- **Free and Open Source**: Available on GitHub, fully customizable and open to community contributions.

# 🚀 Get Started

To start using FMHY SafeGuard, follow these steps:
1. Download the extension from the [Releases page](https://github.com/fmhy/FMHY-SafeGuard/releases) or the [Firefox page](https://addons.mozilla.org/en-US/firefox/addon/fmhy-safeguard/)/[Chrome Page](https://chromewebstore.google.com/detail/fmhy-safeguard/ihcppnlmkfeclmehgdhjkglkbmiemnmp).
2. Install it into your browser and start browsing securely.
3. Customize settings, such as theme, filtered site count, warning page toggles, and filter update frequency.

# 💬 Support & Contributions

For questions or support, feel free to open an issue on [GitHub](https://github.com/fmhy/FMHY-SafeGuard/issues). If you'd like to contribute, check out our contribution guidelines.

# 🌐 Quick Links
- [Download the Extension](https://github.com/fmhy/FMHY-SafeGuard/releases)
- [Contribute on GitHub](https://github.com/fmhy/FMHY-SafeGuard/pulls)

# 📜 Credits
- [FMHY Filterlist](https://github.com/fmhy/FMHYFilterlist), the service used to detect unsafe/potentially unsafe sites, created by FMHY
- [FMHY Bookmarks](https://github.com/fmhy/bookmarks), the service used to detect starred sites, created by FMHY
- [FMHY Edit](https://github.com/fmhy/edit), the service used to detect safe sites, created by FMHY
- [FMHY Related Sites/Projects List](https://github.com/fmhy/FMHY-SafeGuard/blob/main/fmhy-filterlist.txt), the service used to detect FMHY related sites/projects, created by FMHY
- [Kenneth Hendricks](https://github.com/kenhendricks00), the original creator of the FMHY SafeGuard Extension