update readme to be way better, and bump PV & package.json
This commit is contained in:
parent
039582baae
commit
53ca898b13
19
README.md
19
README.md
|
@ -1,14 +1,15 @@
|
|||
# pianoverse client for TS
|
||||
# pianoverse.net protodef's and client
|
||||
This contains the protocol definitions for pianoverse.net. Reversed from using protobuf_inspector on the packets sent through server and client.
|
||||
|
||||
## install
|
||||
run `bun add pianoverse`
|
||||
then import `pianoverse`
|
||||
## Requirements
|
||||
1. [Bun](https://bun.sh/docs/installation)
|
||||
|
||||
## requirements
|
||||
1. bun
|
||||
2. a brain
|
||||
## Contact
|
||||
Please contact me on Discord @fucksophie. I'm in the pianoverse discord. You can also find me [elsewhere](https://sad.ovh).
|
||||
|
||||
## Example
|
||||
The general API is styled after MPP clients, which Pianoverse has quite a lot of similarities with.
|
||||
|
||||
## example
|
||||
```ts
|
||||
import { Client } from "pianoverse"
|
||||
|
||||
|
@ -24,4 +25,4 @@ client.on("message", (user, content) => {
|
|||
client.message("Hi :P")
|
||||
}
|
||||
})
|
||||
```
|
||||
```
|
|
@ -2,7 +2,7 @@
|
|||
"name": "pianoverse",
|
||||
"module": "index.ts",
|
||||
"type": "module",
|
||||
"version": "v1.0.0",
|
||||
"version": "v1.0.1",
|
||||
"license": "GPL-3.0-only",
|
||||
"homepage": "https://git.sad.ovh/sophie/pianoverse",
|
||||
"bugs": "https://git.sad.ovh/sophie/pianoverse/issues",
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
// PV version = 13661e19e8c210d990baa4d96aa8905430c709d5
|
||||
// PV version = 0cdf4ec01ef9a5de77ad785183b3f56fcd0b58db
|
||||
|
||||
syntax = "proto3";
|
||||
|
||||
|
|
Loading…
Reference in a new issue