docs(README.md): remove outdated userscript documentation and browser integration setup

This commit is contained in:
pacnpal
2025-01-30 07:49:20 -05:00
parent 719845b1c8
commit 0bb99d3c6d
3 changed files with 0 additions and 372 deletions

View File

@@ -40,14 +40,6 @@ Then visit `http://localhost:8000` to start managing your AdGuard Home filtering
- ✅ Implements official AdGuard Home API spec
- 🐳 Docker support
### Browser Integration
- 🔎 404 Page Checker Userscript
- Automatically detects 404 responses while browsing
- Checks if failed domains are blocked by AdGuard Home
- Shows unblock notifications with one-click actions
- Configurable settings and caching system
- Tampermonkey integration for all major browsers
## Requirements
### System Requirements
@@ -158,18 +150,6 @@ python -m uvicorn src.simpleguardhome.main:app --reload
The application will be available at `http://localhost:8000`
## Browser Integration Setup
1. Install the [Tampermonkey](https://www.tampermonkey.net/) browser extension
2. Navigate to the `userscript` directory in this repository
3. Install the `simpleguardhome-404-checker.user.js` script
4. Configure the script with your AdGuard Home instance details
The userscript will automatically:
- Monitor web requests for 404 responses
- Check if failed domains are blocked
- Show notifications for blocked domains
- Provide quick unblock options
## API Documentation
The API documentation is automatically generated by FastAPI using:
@@ -226,9 +206,6 @@ simpleguardhome/
│ └── index.html # Web interface
├── static/
│ └── simpleguardhome.png # Project logo
├── userscript/
│ ├── README.md # Userscript documentation
│ └── simpleguardhome-404-checker.user.js
├── rules_backup/ # Backup storage location
├── requirements.txt
├── setup.py