Skip to content

Commit e2e46e4

Browse files
committed
readme
1 parent 04ab456 commit e2e46e4

2 files changed

Lines changed: 12 additions & 4 deletions

File tree

.markdownlint.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{
22
"MD024": false,
3-
"MD013": {"line_length": 500}
3+
"MD013": {"line_length": 500},
4+
"MD001": false
45
}

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
11

22
# PyJavaBridge
33

4-
A paper plugin that exposes bukkit APIs to python scripts.
4+
**Expose bukkit APIs to python scripts via easy-to-use wrappers.**
55

6-
See examples/ for examples.
6+
```py
7+
from bridge import *
78

8-
Put your scripts to plugins/pyjavabridge/scripts and they will be ran on boot.
9+
# Use via /helloworld
10+
@command("Hello world command")
11+
async def helloworld(event: Event):
12+
event.player.send_message("Hello, World!")
13+
```
14+
15+
The entire API is, at core, asynchronous.
916

1017
## Docs
1118

0 commit comments

Comments
 (0)