refactor: Refactoring most of the project
Some checks failed
🧪 Integration Testing / 🔧 Test Integration (2025.9.4, 3.13) (push) Failing after 24s
Some checks failed
🧪 Integration Testing / 🔧 Test Integration (2025.9.4, 3.13) (push) Failing after 24s
Signed-off-by: Rafal Zielinski <sq4ind@gmail.com>
This commit is contained in:
36
README.md
36
README.md
@@ -1,13 +1,7 @@
|
||||
# 🛡️ AdGuard Control Hub
|
||||
|
||||
[](https://github.com/custom-components/hacs)
|
||||
[](https://git.sq4ind.eu/sq4ind/adguard-control-hub/releases)
|
||||
[](LICENSE)
|
||||
|
||||
**The ultimate Home Assistant integration for AdGuard Home**
|
||||
|
||||
---
|
||||
|
||||
## ✨ Features
|
||||
|
||||
### 🎯 Smart Client Management
|
||||
@@ -27,16 +21,12 @@
|
||||
- Automation-friendly services for advanced workflows
|
||||
- Real-time DNS and blocking statistics
|
||||
|
||||
---
|
||||
|
||||
## 📦 Installation
|
||||
|
||||
### 🔧 Method 1: HACS (Recommended)
|
||||
|
||||
1. Open Home Assistant and go to **HACS > Integrations**
|
||||
2. Click menu (⋮) → **Custom repositories**
|
||||
3. Add repository URL:
|
||||
`https://git.sq4ind.eu/sq4ind/adguard-control-hub`
|
||||
3. Add repository URL: `https://git.sq4ind.eu/sq4ind/adguard-control-hub`
|
||||
4. Set category to **Integration**, click **Add**
|
||||
5. Search for **AdGuard Control Hub**
|
||||
6. Click **Install**, then restart Home Assistant
|
||||
@@ -44,24 +34,18 @@
|
||||
8. Search and select **AdGuard Control Hub**, enter your AdGuard Home details
|
||||
|
||||
### 🛠️ Method 2: Manual Installation
|
||||
|
||||
1. Download the latest release zip from your Gitea repository
|
||||
2. Extract `custom_components/adguard_hub` into your Home Assistant config directory
|
||||
3. Restart Home Assistant
|
||||
4. Add integration via UI as per above
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ Configuration
|
||||
|
||||
- **Host**: IP or hostname of your AdGuard Home
|
||||
- **Port**: Default 3000 unless customized
|
||||
- **Username & Password**: Admin credentials for AdGuard Home
|
||||
- **SSL**: Enable if AdGuard Home runs HTTPS
|
||||
- **Verify SSL**: Disable for self-signed certificates
|
||||
|
||||
---
|
||||
|
||||
## 🎬 Use Cases & Examples
|
||||
|
||||
### Parental Controls - Kids Bedtime Automation
|
||||
@@ -106,8 +90,6 @@ data:
|
||||
clients: ["all"]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📱 Dashboard Examples
|
||||
|
||||
**Main Control Panel:**
|
||||
@@ -143,24 +125,12 @@ tap_action:
|
||||
clients: ["all"]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🤝 Support & Contribution
|
||||
|
||||
- Full documentation and setup examples in the repository wiki.
|
||||
- Report issues or request features via the repository's issue tracker.
|
||||
- Contributions welcome—please read the contribution guidelines.
|
||||
|
||||
---
|
||||
|
||||
## 📄 License
|
||||
This project is licensed under the MIT License. See the LICENSE file for details.
|
||||
|
||||
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
|
||||
|
||||
---
|
||||
|
||||
Made with ❤️ and professional care, so you control your AdGuard Home network integration!
|
||||
|
||||
---
|
||||
|
||||
[](https://github.com/custom-components/hacs) | [Releases](https://git.sq4ind.eu/sq4ind/adguard-control-hub/releases) | [Issues](https://git.sq4ind.eu/sq4ind/adguard-control-hub/issues) | [License](LICENSE)
|
||||
Made with ❤️ and professional care, so you control your AdGuard Home network integration!
|
Reference in New Issue
Block a user