Skip to content

Commit 527d556

Browse files
committed
Updating readme
1 parent bb3eaa9 commit 527d556

File tree

5 files changed

+34
-30
lines changed

5 files changed

+34
-30
lines changed

PyPI/Package/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ webui.wait()
2424
python test.py
2525
```
2626

27-
![ScreenShot](https://raw.githubusercontent.com/alifcommunity/webui/main/screenshot.png)
27+
![ScreenShot](https://raw.githubusercontent.com/webui-dev/webui/main/screenshot.png)

PyPI/Package/pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ classifiers = [
1818
]
1919

2020
[project.urls]
21-
"Homepage" = "https://github.com/alifcommunity/webui"
22-
"Bug Tracker" = "https://github.com/alifcommunity/webui/issues"
21+
"Homepage" = "https://github.com/webui-dev/webui"
22+
"Bug Tracker" = "https://github.com/webui-dev/webui/issues"
2323

2424
[tool.setuptools]
2525
include-package-data = true

PyPI/Package/src/webui/webui.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# webui_lib Library 2.3.0
33
#
44
# http://webui.me
5-
# https://github.com/alifcommunity/webui
5+
# https://github.com/webui-dev/webui
66
#
77
# Copyright (c) 2020-2023 Hassan Draga.
88
# Licensed under MIT License.

PyPI/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# WebUI PyPI Package
22

33
```sh
4-
git clone https://github.com/alifcommunity/webui.git
4+
git clone https://github.com/webui-dev/webui.git
55
cd webui/packages/PyPI
66
python -m pip install --upgrade pip
77
python -m pip install --upgrade build

README.md

Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,42 @@
11
# WebUI Python v2.3.0
22

3-
[![Website](https://img.shields.io/circleci/project/github/badges/shields/master?style=for-the-badge)](https://github.com/alifcommunity/webui) [![Website](https://img.shields.io/github/issues/alifcommunity/webui.svg?branch=master&style=for-the-badge&url=https://google.com)](https://github.com/alifcommunity/webui/issues) [![Website](https://img.shields.io/website?label=webui.me&style=for-the-badge&url=https://google.com)](https://webui.me/)
3+
[![Website](https://img.shields.io/circleci/project/github/badges/shields/master?style=for-the-badge)](https://github.com/webui-dev/webui) [![Website](https://img.shields.io/github/issues/webui-dev/webui.svg?branch=master&style=for-the-badge&url=https://google.com)](https://github.com/webui-dev/webui/issues) [![Website](https://img.shields.io/website?label=webui.me&style=for-the-badge&url=https://google.com)](https://webui.me/)
44

55
> Use any web browser as GUI, with Python in the backend and HTML5 in the frontend, all in a lightweight Python pypi package.
66
77
![ScreenShot](screenshot.png)
88

9-
> :warning: **Notice**:
10-
>
11-
> * WebUI it's not a web-server solution or a framework, but it's an lightweight portable Python package to use any installed web browser as a user interface.
12-
>
13-
> * We are currently writing documentation.
14-
159
## Features
1610

17-
- Original library written in Pure C
1811
- Fully Independent (*No need for any third-party runtimes*)
1912
- Lightweight *~900 Kb* for the whole package & Small memory footprint
2013
- Fast binary communication protocol between WebUI and the browser (*Instead of JSON*)
2114
- Multi-platform & Multi-Browser
2215
- Using private profile for safety
16+
- Original library written in Pure C
2317

2418
## Screenshot
2519

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

2822
![ScreenShot](webui_python_example.png)
2923

24+
## Installation
25+
26+
`pip install webui2`
27+
28+
## Minimal Example
29+
30+
```
31+
from webui import webui
32+
33+
MyWindow = webui.window()
34+
MyWindow.show('<html>Hello World</html>')
35+
webui.wait()
36+
```
37+
38+
[More examples](https://github.com/webui-dev/python-webui/tree/main/examples)
39+
3040
## CppCon 2019 Presentation
3141

3242
[Borislav Stanimirov](https://ibob.bg/) explained at [C++ Conference 2019 (*YouTube*)](https://www.youtube.com/watch?v=bbbcZd4cuxg) how beneficial it is to use the web browser as GUI.
@@ -61,11 +71,7 @@ Think of WebUI like a WebView controller, but instead of embedding the WebView c
6171

6272
## Documentation
6373

64-
- [Online Documentation - Python](https://webui.me/docs/#/python_api)
65-
66-
## Examples
67-
68-
- [Python](https://github.com/alifcommunity/webui/tree/main/examples/Python)
74+
- [Online Documentation](https://webui.me/docs/#/python_api)
6975

7076
## Supported Web Browsers
7177

@@ -106,21 +112,19 @@ Think of WebUI like a WebView controller, but instead of embedding the WebView c
106112

107113
| Language | Status | Link |
108114
| ------ | ------ | ------ |
109-
| C | ✔️ | [examples/C](https://github.com/alifcommunity/webui/tree/main/examples/C) |
110-
| C++ | ✔️ | [examples/C++](https://github.com/alifcommunity/webui/tree/main/examples/C%2B%2B) |
111-
| Python | ✔️ | [examples/Python](https://github.com/alifcommunity/webui/tree/main/examples/Python) |
112-
| JavaScript | ✔️ | [examples/TypeScript/Nodejs](https://github.com/alifcommunity/webui/tree/main/examples/TypeScript/Nodejs) |
113-
| TypeScript | ✔️ | [examples/TypeScript/Deno](https://github.com/alifcommunity/webui/tree/main/examples/TypeScript/Deno) |
114-
| Go | ✔️ | [examples/Go](https://github.com/alifcommunity/webui/tree/main/examples/Go) |
115-
| Rust | *Not Complete* | [examples/Rust](https://github.com/alifcommunity/webui/tree/main/examples/Rust) |
116-
| V | ✔️ | [malisipi/vwebui](https://github.com/malisipi/vwebui) |
117-
| Nim | *Not Complete* | [neroist/webui](https://github.com/neroist/webui) |
118-
| Zig | *Not Complete* | [desttinghim/webui](https://github.com/desttinghim/webui) |
115+
| C/C++ | ✔️ | [WebUI](https://github.com/webui-dev/webui) |
116+
| Python | ✔️ | [Python-WebUI](https://github.com/webui-dev/python-webui) |
117+
| TypeScript | ✔️ | [Deno](https://github.com/webui-dev/deno-webui) |
118+
| Go | ✔️ | [Go-WebUI](https://github.com/webui-dev/go-webui) |
119+
| Rust | *Not Complete* | [Rust-WebUI](https://github.com/webui-dev/rust-webui) |
120+
| V | ✔️ | [V-WebUI](https://github.com/webui-dev/v-webui) |
121+
| Nim | ✔️ | [webui-WebUI](https://github.com/webui-dev/nim-webui) |
122+
| Zig | *Not Complete* | [Zig-WebUI](https://github.com/webui-dev/zig-webui) |
119123

120124
### License
121125

122126
> Licensed under MIT License.
123127
124128
### Stargazers
125129

126-
[![Stargazers repo roster for @alifcommunity/webui](https://reporoster.com/stars/alifcommunity/webui)](https://github.com/alifcommunity/webui/stargazers)
130+
[![Stargazers repo roster for @webui-dev/webui](https://reporoster.com/stars/webui-dev/python-webui)](https://github.com/webui-dev/python-webui/stargazers)

0 commit comments

Comments
 (0)