Skip to content

Commit 4b204bb

Browse files
authored
Update README with async and performance information
Added notes on asynchronous methods and performance tips. Signed-off-by: Omena0 <Omena0MC@gmail.com>
1 parent a9cc86b commit 4b204bb

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,20 @@ async def helloworld(event: Event):
1313
```
1414

1515
The entire API is, at core, asynchronous.
16+
Though you do not need to await any methods unless you want to wait for the call to complete.
1617

1718
## Documentation
1819

1920
See [The Docs](https://omena0.github.io/PyJavaBridge/index.html)
2021

22+
For quick searches use the pjb cli script.
23+
24+
## Performance
25+
26+
Currently the performance is suboptimal, the current bottleneck is the bridge itself.
27+
You should avoid doing anything that sends many requests over the bridge.
28+
If possible you should always use `server.frame()` to batch requests.
29+
2130
## Changelog
2231

2332
See [changelog.md](changelog.md)

0 commit comments

Comments
 (0)