raoul/webappify
1
0
Fork 0
Code Issues Pull Requests 1 Projects Releases 4 Wiki Activity

Update the README
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
Details
ci/woodpecker/pr/woodpecker Pipeline was successful
Details
ci/woodpecker/pull_request_closed/woodpecker Pipeline was successful
Details

Browse Source
This commit is contained in:
Raoul Snyman 2024-09-27 11:30:23 -05:00
parent 8fa772267c
commit 49fd14d7c2
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.rst
View File

@ -3,8 +3,8 @@ WebAppify
|pypi| |license| |build| |pypi| |license| |build|
WebAppify is a simple module to easily create your own desktop apps of websites. WebAppify uses PyQt5 and QtWebEngine WebAppify is a simple module to easily create your own desktop apps of websites. WebAppify uses PySide6 and QtWebEngine
for displaying the web page, and works on Python 3.8 and up. for displaying the web page, and works on Python 3.10 and up.
To create your own desktop web app, import and set up the WebApp class. To create your own desktop web app, import and set up the WebApp class.
@ -19,8 +19,7 @@ This will create a window with the website, using the icon provided.
.. note:: .. note::
If your site needs Flash Player, you'll need the appropriate Flash Player plugin installed system-wide. For QtWebKit If your site needs Flash Player, you'll need the appropriate Flash Player plugin installed system-wide.
you will need the NPAPI plugin, and for QtWebEngine you will need the PPAPI plugin.
Additional Options Additional Options
------------------ ------------------
@ -31,7 +30,7 @@ Additional Options
.. important:: .. important::
This option was changed in version 0.4.0 from ``canMinimizeToTray`` to ``can_minimize_to_tray``. The old option This option was changed in version 0.4.0 from ``canMinimizeToTray`` to ``can_minimize_to_tray``. The old option
is still available, but is deprecated. It will be removed in 0.5.0. is still available, but is deprecated. It will be removed in 0.6.0.
To install a system tray icon, and minimize your application to the system tray, simply pass To install a system tray icon, and minimize your application to the system tray, simply pass
``can_minimize_to_tray=True`` to the class and a tray icon will be installed with the necessary menu options. ``can_minimize_to_tray=True`` to the class and a tray icon will be installed with the necessary menu options.