docs📚
This commit is contained in:
42
README.md
42
README.md
@@ -14,23 +14,34 @@ Get visibility of what's going on on your WIFI/LAN network. Scan for devices, po
|
|||||||
|
|
||||||
| ![Main screen][main] | ![Screen 1][screen1] | ![Screen 5][screen5] |
|
| ![Main screen][main] | ![Screen 1][screen1] | ![Screen 5][screen5] |
|
||||||
|----------------------|----------------------| ----------------------|
|
|----------------------|----------------------| ----------------------|
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>📷 Click for more screenshots</summary>
|
||||||
|
|
||||||
| ![Screen 3][screen3] | ![Screen 4][screen4] | ![Screen 6][screen6] |
|
| ![Screen 3][screen3] | ![Screen 4][screen4] | ![Screen 6][screen6] |
|
||||||
|
|----------------------|----------------------|----------------------|
|
||||||
| ![Screen 8][screen8] | ![Report 2][report2] | ![Screen 9][screen9] |
|
| ![Screen 8][screen8] | ![Report 2][report2] | ![Screen 9][screen9] |
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
## Why PiAlert❓
|
<details>
|
||||||
|
<summary>❓ Why use PiAlert?</summary>
|
||||||
|
|
||||||
Most of us don't know what's going on on our home network, but we want our family and data to be safe. _Command-line tools_ are great, but the output can be _hard to understand_ and action if you are not a network specialist.
|
<hr>
|
||||||
|
|
||||||
PiAlert gives you peace of mind. _Visualize and immediately report 📬_ what is going on in your network - this is the first step to enhance your _network security 🔐_.
|
Most of us don't know what's going on on our home network, but we want our family and data to be safe. _Command-line tools_ are great, but the output can be _hard to understand_ and action if you are not a network specialist.
|
||||||
|
|
||||||
PiAlert combines several network and other scanning tools 🔍 with notifications 📧 into one user-friendly package 📦.
|
PiAlert gives you peace of mind. _Visualize and immediately report 📬_ what is going on in your network - this is the first step to enhance your _network security 🔐_.
|
||||||
|
|
||||||
Setup a _kill switch ☠_ for your network via a smart plug with the available [Home Assistant](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/HOME_ASSISTANT.md) integration. Implement custom automations with the [CSV device Exports 📤](https://github.com/jokob-sk/Pi.Alert/tree/main/front/plugins/csv_backup), [Webhooks](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/WEBHOOK_N8N.md), or [API endpoints](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/API.md) features.
|
PiAlert combines several network and other scanning tools 🔍 with notifications 📧 into one user-friendly package 📦.
|
||||||
|
|
||||||
Extend the app if you want to create your own scanner [Plugin](https://github.com/jokob-sk/Pi.Alert/tree/main/front/plugins#readme) and handle the results and notifications in PiAlert.
|
Setup a _kill switch ☠_ for your network via a smart plug with the available [Home Assistant](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/HOME_ASSISTANT.md) integration. Implement custom automations with the [CSV device Exports 📤](https://github.com/jokob-sk/Pi.Alert/tree/main/front/plugins/csv_backup), [Webhooks](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/WEBHOOK_N8N.md), or [API endpoints](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/API.md) features.
|
||||||
|
|
||||||
Looking forward to your contributions if you decide to share your work with the community ❤.
|
Extend the app if you want to create your own scanner [Plugin](https://github.com/jokob-sk/Pi.Alert/tree/main/front/plugins#readme) and handle the results and notifications in PiAlert.
|
||||||
|
|
||||||
|
Looking forward to your contributions if you decide to share your work with the community ❤.
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
## Scan Methods, Notifications, Integration, Extension system
|
## Scan Methods, Notifications, Integration, Extension system
|
||||||
|
|
||||||
@@ -60,23 +71,30 @@ Looking forward to your contributions if you decide to share your work with the
|
|||||||
|
|
||||||
## ❤ Support me for...
|
## ❤ Support me for...
|
||||||
|
|
||||||
|
- I don't get burned out and the app survives longer🔥🤯
|
||||||
- Regular updates to keep your data and family safe 🔄
|
- Regular updates to keep your data and family safe 🔄
|
||||||
- Better and more functionality➕
|
- Better and more functionality➕
|
||||||
- I don't get burned out and the app survives longer🔥🤯
|
|
||||||
- Quicker and better support with issues 🆘
|
- Quicker and better support with issues 🆘
|
||||||
- Less grumpy me 😄
|
- Less grumpy me 😄
|
||||||
|
|
||||||
| [](https://github.com/sponsors/jokob-sk) | [](https://www.buymeacoffee.com/jokobsk) | [](https://www.patreon.com/user?u=84385063) |
|
| [](https://github.com/sponsors/jokob-sk) | [](https://www.buymeacoffee.com/jokobsk) | [](https://www.patreon.com/user?u=84385063) |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
|
|
||||||
- Bitcoin: `1N8tupjeCK12qRVU2XrV17WvKK7LCawyZM`
|
<details>
|
||||||
- Ethereum: `0x6e2749Cb42F4411bc98501406BdcD82244e3f9C7`
|
<summary>Click for more ways to donate</summary>
|
||||||
|
|
||||||
|
- Bitcoin: `1N8tupjeCK12qRVU2XrV17WvKK7LCawyZM`
|
||||||
|
- Ethereum: `0x6e2749Cb42F4411bc98501406BdcD82244e3f9C7`
|
||||||
|
|
||||||
|
📧 Email me at [jokob@duck.com](mailto:jokob@duck.com?subject=PiAlert) if you want to get in touch or if I should add other sponsorship platforms.
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
|
||||||
> 📧 Email me at [jokob@duck.com](mailto:jokob@duck.com?subject=PiAlert) if you want to get in touch or if I should add other sponsorship platforms.
|
|
||||||
|
|
||||||
### ⭐ Sponsors
|
### ⭐ Sponsors
|
||||||
|
|
||||||
Thank you to all the wonderful people who have sponsored (=burnout prevention) this project:
|
Thank you to all the wonderful people who have sponsored this project (=prevented my burnout):
|
||||||
|
|
||||||
<!-- DO NOT MODIFY BELOW -->
|
<!-- DO NOT MODIFY BELOW -->
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user