Skip to content

Commit 15c4c8c

Browse files
committed
Update readme
1 parent 24dde11 commit 15c4c8c

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

README.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,37 @@
11
<div align="center">
22

3-
# WebUI Python v2.4.2
3+
![Logo](img/webui.png)
44

5-
[![Website](https://img.shields.io/circleci/project/github/badges/shields/master?style=for-the-badge)](https://github.com/webui-dev/python-webui) [![Website](https://img.shields.io/github/issues/webui-dev/python-webui.svg?branch=master&style=for-the-badge&url=https://google.com)](https://github.com/webui-dev/python-webui/issues) [![Website](https://img.shields.io/website?label=webui.me&style=for-the-badge&url=https://google.com)](https://webui.me/)
5+
# Python WebUI v2.4.2
66

7-
> Use any web browser as GUI, with Python in the backend and HTML5 in the frontend, all in a lightweight Python pypi package.
7+
[last-commit]: https://img.shields.io/github/last-commit/webui-dev/webui?style=for-the-badge&logo=github&logoColor=C0CAF5&labelColor=414868
8+
[release-version]: https://img.shields.io/github/v/tag/webui-dev/webui?style=for-the-badge&logo=webtrees&logoColor=C0CAF5&labelColor=414868&color=7664C6
9+
[license]: https://img.shields.io/github/license/webui-dev/webui?style=for-the-badge&logo=opensourcehardware&label=License&logoColor=C0CAF5&labelColor=414868&color=8c73cc
810

9-
![ScreenShot](screenshot.png)
11+
[![][last-commit]](https://github.com/webui-dev/python-webui/pulse)
12+
[![][release-version]](https://github.com/webui-dev/python-webui/releases/latest)
13+
[![][license]](https://github.com/webui-dev/python-webui/blob/main/LICENSE)
14+
15+
> Use any web browser as GUI, with Python in the backend and HTML5 in the frontend, all in a lightweight Python package.
16+
17+
![ScreenShot](img/screenshot.png)
1018

1119
</div>
1220

1321
## Features
1422

15-
- Fully Independent (*No need for any third-party runtimes*)
16-
- Lightweight *~900 Kb* for the whole package & Small memory footprint
17-
- Fast binary communication protocol between WebUI and the browser (*Instead of JSON*)
23+
- Portable (*Needs only a web browser at runtime*)
24+
- Lightweight (*Few Kb library*) & Small memory footprint
25+
- Fast binary communication protocol
1826
- Multi-platform & Multi-Browser
1927
- Using private profile for safety
20-
- Original library written in Pure C
28+
- Original library is written in Pure C
2129

2230
## Screenshot
2331

24-
This [text editor example](https://github.com/webui-dev/python-webui/tree/main/examples) is written in Python using WebUI as the GUI library.
32+
This [text editor example](https://github.com/webui-dev/python-webui/tree/main/examples/text-editor) is written in Python using WebUI as the GUI library.
2533

26-
![ScreenShot](webui_python_example.png)
34+
![ScreenShot](img/webui_python_example.png)
2735

2836
## Installation
2937

@@ -53,7 +61,7 @@ webui.wait()
5361
<a href="https://www.youtube.com/watch?v=bbbcZd4cuxg"><img src="https://img.youtube.com/vi/bbbcZd4cuxg/0.jpg" alt="Embrace Modern Technology: Using HTML 5 for GUI in C++ - Borislav Stanimirov - CppCon 2019"></a>
5462
</div> -->
5563

56-
![ScreenShot](cppcon_2019.png)
64+
![ScreenShot](img/cppcon_2019.png)
5765

5866
## UI & The Web Technologies
5967

@@ -65,7 +73,7 @@ Today's web browsers have everything a modern UI needs. Web browsers are very so
6573

6674
## How does it work?
6775

68-
![ScreenShot](webui_diagram.png)
76+
![ScreenShot](img/webui_diagram.png)
6977

7078
Think of WebUI like a WebView controller, but instead of embedding the WebView controller in your program, which makes the final program big in size, and non-portable as it needs the WebView runtimes. Instead, by using WebUI, you use a tiny static/dynamic library to run any installed web browser and use it as GUI, which makes your program small, fast, and portable. **All it needs is a web browser**.
7179

0 commit comments

Comments
 (0)