diff --git a/desktop/README.md b/desktop/README.md index 98c519e..433fd5d 100644 --- a/desktop/README.md +++ b/desktop/README.md @@ -1,19 +1,12 @@ -```md -# angelhome + +##### angelhome desktop app for angelhome `main.py` opens site in a locked qtwebengine browser instead of normal browser. -## compatible with - -- linux -- pyside6 -- qtwebengine - -### does - -- allows only the approved https host +- desktop wrapper +- allows only approved https - blocks external navigation - blocks popups - blocks downloads @@ -23,7 +16,7 @@ desktop app for angelhome - stores login/session data beside the app, keeps between restarts - logs startup/runtime errors -### requirements +#### requirements install python packages: @@ -31,7 +24,7 @@ install python packages: pip install PySide6 ``` -### run with python +#### run with python ```bash python3 main.py @@ -43,13 +36,13 @@ or: python main.py ``` -## log output +#### log output ```text angelhome_data/logs/angelhome.out.log ``` -## persistent data +#### persistent data local app data is stored beside the script or bundled binary: