Update README and CHANGELOG for 0.4.0 release
This commit is contained in:
parent
6a84bd0749
commit
e2628bce55
@ -1,6 +1,16 @@
|
||||
Changelog
|
||||
=========
|
||||
|
||||
Version 0.4.0
|
||||
-------------
|
||||
|
||||
Released 2022-06-10
|
||||
|
||||
- Rename ``canMinimizeToTray`` to ``can_minimize_to_tray``
|
||||
- Remove support for Python versions less than 3.8
|
||||
- Move to hatch for package management
|
||||
- Update README
|
||||
|
||||
Version 0.3
|
||||
-----------
|
||||
|
||||
|
36
README.rst
36
README.rst
@ -1,8 +1,8 @@
|
||||
WebAppify
|
||||
=========
|
||||
|
||||
WebAppify is a simple module to easily create your own desktop apps of websites. WebAppify uses PyQt5 and QtWebKit or
|
||||
QtWebEngine for displaying the web page, and works on Python 2.7 and Python 3.4 and up.
|
||||
WebAppify is a simple module to easily create your own desktop apps of websites. WebAppify uses PyQt5 and QtWebEngine
|
||||
for displaying the web page, and works on Python 3.8 and up.
|
||||
|
||||
To create your own desktop web app, import and set up the WebApp class.
|
||||
|
||||
@ -15,19 +15,27 @@ To create your own desktop web app, import and set up the WebApp class.
|
||||
|
||||
This will create a window with the website, using the icon provided.
|
||||
|
||||
Additional Options
|
||||
------------------
|
||||
|
||||
Version 0.2 comes with the option of minimizing to the system tray. Simply pass ``canMinimizeToTray=True`` to the class
|
||||
and a tray icon will be installed with the necessary menu options.
|
||||
|
||||
.. code:: python
|
||||
|
||||
app = WebApp('OpenStreetMap', 'https://www.openstreetmap.org', 'osm.png', canMinimizeToTray=True)
|
||||
|
||||
Clicking on the tray icon will show the window, while right-clicking will show the menu.
|
||||
|
||||
.. note::
|
||||
|
||||
If your site needs Flash Player, you'll need the appropriate Flash Player plugin installed system-wide. For QtWebKit
|
||||
you will need the NPAPI plugin, and for QtWebEngine you will need the PPAPI plugin.
|
||||
|
||||
Additional Options
|
||||
------------------
|
||||
|
||||
``can_minimize_to_tray``
|
||||
''''''''''''''''''''''''
|
||||
|
||||
.. important::
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
.. code:: python
|
||||
|
||||
app = WebApp('OpenStreetMap', 'https://www.openstreetmap.org', 'osm.png', can_minimize_to_tray=True)
|
||||
|
||||
Clicking on the tray icon will show the window, while right-clicking will show the menu.
|
||||
|
Loading…
Reference in New Issue
Block a user