Skip to content

Commit 56b76d5

Browse files
committed
feat: add funding information and sponsorship options to support project maintenance
1 parent b748f30 commit 56b76d5

3 files changed

Lines changed: 41 additions & 2 deletions

File tree

.github/FUNDING.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
github: sirkirby
2+
custom:
3+
- "https://github.com/sirkirby/unifi-network-rules/blob/main/FUNDING.md"

FUNDING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Sponsor UniFi Network Rules
2+
3+
UniFi Network Rules is an independent custom integration for Home Assistant. It helps Home Assistant users manage UniFi firewall policies, traffic rules, port forwards, static routes, NAT rules, QoS rules, VPN configuration, WLANs, and other controller-backed settings from automations and switch entities.
4+
5+
If this integration saves you time or makes your home lab easier to manage, sponsorship helps keep it maintained.
6+
7+
## What Sponsorship Funds
8+
9+
Sponsorship goes toward the recurring work that keeps this integration reliable as both Home Assistant and UniFi Network continue to change:
10+
11+
- Home Assistant compatibility work across new core releases, validation changes, and HACS expectations.
12+
- Live UniFi controller testing for API behavior, firmware changes, and controller edge cases.
13+
- AI-assisted development, review, test generation, release notes, and maintenance work.
14+
- Release maintenance, issue triage, docs, examples, diagnostics, and security hardening.
15+
- Regression testing for high-risk rule types such as firewall policies, NAT rules, routes, VPNs, and port forwards.
16+
17+
## Support Options
18+
19+
GitHub Sponsors is the project funding path:
20+
21+
Choose the matching tier on GitHub Sponsors:
22+
23+
- [Supporter - $5/month](https://github.com/sponsors/sirkirby?metadata_project=unifi_network_rules&metadata_tier=monthly_5): helps keep compatibility fixes, docs, and issue triage moving.
24+
- [Power user - $15/month](https://github.com/sponsors/sirkirby?metadata_project=unifi_network_rules&metadata_tier=monthly_15): helps cover recurring AI and live-controller maintenance costs.
25+
- [Homelab / team backer - $50/month](https://github.com/sponsors/sirkirby?metadata_project=unifi_network_rules&metadata_tier=monthly_50): for power users, homelabs, and teams relying on this integration.
26+
- [One-time or custom support](https://github.com/sponsors/sirkirby?metadata_project=unifi_network_rules&metadata_tier=custom): for larger contributions, company support, or targeted compatibility work.
27+
28+
## Project Boundaries
29+
30+
Sponsorship supports maintenance, but it does not change the project's safety or governance boundaries:
31+
32+
- The integration remains open source.
33+
- Core features are not paywalled.
34+
- Sponsors do not bypass compatibility checks, Home Assistant review standards, or safe rule-handling patterns.
35+
- Feature priorities still follow user impact, controller safety, maintainability, and the realities of the UniFi API.
36+
37+
Thank you for helping sustain the project.

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,12 @@
88
[![issues][issues-shield]][issues-link]
99
[![validate-badge]][validate-workflow]
1010

11-
[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/sirkirby)
12-
1311
UniFi Network Rules is a custom integration for Home Assistant that integrates with your UniFi Dream Machine/Router to both provide and help you create useful interactions and automations for your Home Lab. The goal of this integration is to simplify policy and rule management for real world use cases. I built this because I wanted to unlock the power of my UniFi firewall. From simple things like screen time and game server access controls for my kids, to more advanced like getting notified when a critical rule is changed and automatically backing up your rules. And most importantly, make all of this easy to use and share with anyone in your home or home lab. I hope you find it useful!
1412

1513
> 📖 **[Quick Start Guide](QUICKSTART.md)** — Installation, setup, and troubleshooting
1614
> 🤝 **[Contributing](CONTRIBUTING.md)** — Development setup and PR workflow
1715
> 🔒 **[Security](SECURITY.md)** — Vulnerability reporting policy
16+
> 💗 **[Sponsor](https://github.com/sponsors/sirkirby)** — Support maintenance, Home Assistant compatibility, UniFi API testing, and releases. See [what sponsorship funds](FUNDING.md).
1817
1918
## What this integration provides
2019

0 commit comments

Comments
 (0)