Skip to content

Commit 6d82d71

Browse files
authored
Update README.md
1 parent e4ba4a4 commit 6d82d71

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,24 @@
22

33
This [tauri](https://v2.tauri.app/) plugin is supposed to make it easy to use Python as backend code.
44
It uses [PyO3](https://pyo3.rs) to call python from rust.
5-
It reads by default the file `src-tauri/src-python/main.py` during
6-
compile time and runs it during startup.
5+
The plugin reads by default the file `src-tauri/src-python/main.py` during
6+
compile time and runs it during startup. It then can call functions that were embedded in this python code.
77

88
Python code can be registered and called from javascript without the
99
requirement to touch rust code at all.
10+
You can still use rust to register all python functions if you have any security concerns,
11+
for example when using inputs from other network interfaces.
1012

1113

12-
You might use it to create simple prototype applications
14+
You might use this plugin to create simple prototype applications
1315
and later re-write functions in rust to improve
1416
performance, add a specific rust library or just call some
1517
low-level code.
1618

17-
## Example
19+
## Example app
1820

19-
There is a running sample application using this plugin and vanilla
20-
Javascript in https://github.com/marcomq/tauri-plugin-python/tree/main/examples/plain-javascript
21+
There is a sample Desktop application for Windows/Linux/MacOS using this plugin and vanilla
22+
Javascript in [examples/plain-javascript](https://github.com/marcomq/tauri-plugin-python/tree/main/examples/plain-javascript)
2123

2224
## Security considerations
2325
This plugin can make it possible to run arbitrary python code that is injected
@@ -32,4 +34,4 @@ In addition, the "registerFunction" command cannot be called again once the
3234
once a user has performed any activity in the UI
3335
This is not supposed to be a full protection against remote attacks.
3436

35-
The plugin should only be used in standalone Desktop, MacOS, IOS or Android mode.
37+
The plugin should only be used in standalone Desktop, MacOS, IOS or Android mode.

0 commit comments

Comments
 (0)