FMHY-SafeGuard/README.md
Kenneth Hendricks 86d1c2b390
Update README.md
2024-10-21 19:46:01 -04:00

89 lines
5.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<p align="center">
<a href="https://github.com/kenhendricks00/FMHY-SafeGuard/releases"><img src="https://github.com/kenhendricks00/FMHY-SafeGuard/blob/main/assets/banner.png" /></a>
</p>
<div align="center">
<a href="https://discord.com/invite/Stz6y6NgNg">
<img src="https://img.shields.io/static/v1?label=Join&message=FMHY&color=c4b5fd" alt="Invite Link"></a>
<a href="https://github.com/kenhendricks00/FMHY-SafeGuard/commits/main/">
<img src="https://img.shields.io/github/last-commit/kenhendricks00/FMHY-SafeGuard?label=Last%20Commit&color=green" alt="Last Commit"></a>
<a href="https://github.com/kenhendricks00/FMHY-SafeGuard/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/kenhendricks00/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/kenhendricks00/FMHY-SafeGuard/blob/main/assets/header.png" style="width: 300px">
</p>
<div align="center">
<table>
<tr>
<td><img src="https://github.com/kenhendricks00/FMHY-SafeGuard/blob/main/assets/icons/default.png"></td>
<td><img src="https://github.com/kenhendricks00/FMHY-SafeGuard/blob/main/assets/icons/starred.png" style="width: 144px"></td>
<td><img src="https://github.com/kenhendricks00/FMHY-SafeGuard/blob/main/assets/icons/safe.png" style="width: 144px"></td>
<td><img src="https://github.com/kenhendricks00/FMHY-SafeGuard/blob/main/assets/icons/potentially_unsafe.png" style="width: 144px"></td>
<td><img src="https://github.com/kenhendricks00/FMHY-SafeGuard/blob/main/assets/icons/unsafe.png" style="width: 144px"></td>
</tr>
<tr>
<td>Default/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/kenhendricks00/FMHY-SafeGuard/blob/main/assets/firefox_addon_image.png" alt="Get FMHY SafeGuard for Firefox"></a>
<a href=""><img src="https://github.com/kenhendricks00/FMHY-SafeGuard/blob/main/assets/chrome_addon_image.png" alt="Get FMHY SafeGuard for Chrome"></a>
<div align="center">
<h2> <b> NOTE: The Chromium version of FMHY SafeGuard is now available! </b> </h2>
<p> <b> However, the extension is currently undergoing review for the Chrome Web Store. </b> </p>
</p>
</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.
# 📋 Usage Instructions
1. **Install the Extension**: Install FMHY SafeGuard from the [Releases Page](https://github.com/kenhendricks00/FMHY-SafeGuard/releases) or the [Firefox page](https://addons.mozilla.org/en-US/firefox/addon/fmhy-safeguard/)/[Chrome Page]().
2. **Browse Securely**: Visit any website and the toolbar icon will automatically update to reflect the sites 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/kenhendricks00/FMHY-SafeGuard/releases) or the [Firefox page](https://addons.mozilla.org/en-US/firefox/addon/fmhy-safeguard/)/[Chrome Page]().
2. Install it into your browser and start browsing securely.
3. Customize the settings to your preferences via the extensions pop-up (Coming soon!).
# 💬 Support & Contributions
For questions or support, feel free to open an issue on [GitHub](https://github.com/kenhendricks00/FMHY-SafeGuard/issues). If you'd like to contribute, check out our contribution guidelines.
# 🌐 Quick Links
- [Download the Extension](https://github.com/kenhendricks00/FMHY-SafeGuard/releases)
- [Contribute on GitHub](https://github.com/kenhendricks00/FMHY-SafeGuard/pulls)
- [FMHY Filterlist Project](https://github.com/fmhy/FMHYFilterlist)
# 📜 Credits
- [FMHY Filterlist](https://github.com/fmhy/FMHYFilterlist), the service used to detect unsafe/potentially unsafe sites, created by FMHY