From 9fa53832a34dd0eed6be0eb3d3516e9cfcec2f0f Mon Sep 17 00:00:00 2001
From: Kenneth Hendricks <50819541+kenhendricks00@users.noreply.github.com>
Date: Wed, 16 Oct 2024 21:45:47 -0400
Subject: [PATCH] Update README.md
---
README.md | 39 ++++++++++++++++++++++++++++++++++++++-
1 file changed, 38 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index e0038b9..8506335 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,44 @@
-
An extension that detects unsafe/potentially unsafe sites using the FMHY Filterlist.
+
Protect Your Browsing with FMHY SafeGuard: Easy Filterlist Integration.
+
+# ๐ก๏ธ What is FMHY SafeGuard?
+
+**FMHY SafeGuard** is a browser extension that keeps you safe by checking websites against the latest filterlists from [FMHY Filterlists](https://github.com/fmhy/FMHYFilterlist). The extension categorizes websites as safe, unsafe, or potentially dangerous, giving you peace of mind while browsing.
+
+# ๐ Key Features
+- **Real-time Site Status**: Instant feedback on whether a site is safe, unsafe, or potentially unsafe, with visual toolbar icons.
+- **Updated Filterlists**: Utilizes the frequently updated FMHY filterlists 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).
+2. **Browse Securely**: Visit any website and the toolbar icon will automatically update to reflect the siteโs safety status (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.
+
+# ๐ Why Choose FMHY SafeGuard?
+
+- **Up-to-date Protection**: Always uses the latest FMHY filterlists 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](https://github.com/kenhendricks00/FMHY-SafeGuard/releases) page.
+2. Install it into your browser and start browsing securely.
+3. Customize the settings to your preferences via the extensionโs pop-up.
+
+# ๐ฌ 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 Filterlists](https://github.com/fmhy/FMHYFilterlist), the service used to detect unsafe/potentially unsafe sites, created by FMHY