From 49baf4b61307f7db7aa1d8e0f932d07b336074cd Mon Sep 17 00:00:00 2001 From: Jokob-sk Date: Sun, 7 May 2023 10:27:41 +1000 Subject: [PATCH] Docs --- README.md | 5 +++-- docs/README.md | 6 ++++++ 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9a63f9ff..f0666661 100755 --- a/README.md +++ b/README.md @@ -70,9 +70,10 @@ The system continuously scans the network for, **New devices**, **New connection - [WatchYourLAN](https://github.com/aceberg/WatchYourLAN) - Lightweight network IP scanner with web GUI (Open source) - [Fing](https://www.fing.com/) - Network scanner app for your Internet security (Commercial, Phone App, Proprietary hardware) -### Old docs +### 📚 Documentation -Device Management [instructions](docs/DEVICE_MANAGEMENT.md) | Old Versions [History](docs/VERSIONS_HISTORY.md) +- Initial Docker Setup: [Docker instructions](https://github.com/jokob-sk/Pi.Alert/blob/main/dockerfiles/README.md) +- App Usage and Configuration: [All Documentation](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/README.md) ### License GPL 3.0 | [Read more here](LICENSE.txt) | Source of the [animated GIF (Loading Animation)](https://commons.wikimedia.org/wiki/File:Loading_Animation.gif) | Source of the [selfhosted Fonts](https://github.com/adobe-fonts/source-sans) diff --git a/docs/README.md b/docs/README.md index 8b8c9832..c0209820 100755 --- a/docs/README.md +++ b/docs/README.md @@ -6,6 +6,12 @@ In the app hover-over settings or fields/labels or click blue in-app ❔ (questi There is also an in-app Help / FAQ section that should be answering frequently asked questions. +### 📥 Installation + + ⚠ Only tested as a [docker container - follow these instructions here](https://github.com/jokob-sk/Pi.Alert/blob/main/dockerfiles/README.md). + > Check out [leiweibau's fork](https://github.com/leiweibau/Pi.Alert/) if you want to install Pi.Alert on the server directly or original instructions for [pucherot's original code](https://github.com/pucherot/Pi.Alert/) + + ### 📚 Table of contents #### Popular/Suggested