Skip to content

Commit 50d3b65

Browse files
committed
Update PyPI readme
1 parent 856daf4 commit 50d3b65

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

PyPI/Package/README.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,32 @@
1-
# WebUI
1+
# Python WebUI v2.4.3
22

3-
Use any web browser as GUI, with Python in the backend and HTML5 in the frontend, all in a lightweight portable lib.
3+
> Use any web browser as GUI, with Python in the backend and HTML5 in the frontend, all in a lightweight Python package.
4+
5+
## Features
6+
7+
- Portable (*Needs only a web browser at runtime*)
8+
- Lightweight (*Few Kb library*) & Small memory footprint
9+
- Fast binary communication protocol
10+
- Multi-platform & Multi-Browser
11+
- Using private profile for safety
12+
- Original library is written in Pure C
13+
14+
## Documentation
415

516
* [Online Documentation](https://webui.me/docs/#/python_api)
617

18+
## Install
19+
720
```sh
821
pip install webui2
922
```
1023

24+
## Example
25+
1126
```python
1227
from webui import webui
1328

14-
def my_function(e : webui.event)
15-
print("Hi!, You clicked on " + e.element + " element")
16-
1729
MyWindow = webui.window()
18-
MyWindow.bind("MyID", my_function)
19-
MyWindow.show("<html>Hello World</html>")
30+
MyWindow.show('<html><script src="webui.js"></script> Hello World! </html>')
2031
webui.wait()
2132
```
22-
23-
```sh
24-
python test.py
25-
```
26-
27-
![ScreenShot](https://raw.githubusercontent.com/webui-dev/python-webui/main/screenshot.png)

0 commit comments

Comments
 (0)