teeworlds-go/go-teeworlds-protocol
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Massage readme

Browse source
This commit is contained in:
ChillerDragon 2024-06-23 17:02:50 +08:00
parent aa5b67aab7
commit 4a47664fd1
1 changed files with 3 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -1,15 +1,9 @@
# go-teeworlds-protocol # go-teeworlds-protocol
## Early and active development! Still undergoing major refactors! # WARNING! NOT READY TO BE USED YET! Apis might change. Packages and repository might be renamed!
## WARNING! NOT READY TO BE USED YET!
## Apis might change. Packages and repository might be renamed!
A client side network protocol implementation of the game teeworlds. A client side network protocol implementation of the game teeworlds.
## low level api for power users
The packages **chunk7, messages7, network7, packer, protocol7** Implement the low level 0.7 teeworlds protocol. Use them if you want to build something advanced such as a custom proxy.
## high level api for ease of use ## high level api for ease of use
The package **teeworlds7** implements a high level client library. Designed for ease of use. The package **teeworlds7** implements a high level client library. Designed for ease of use.
@ -51,11 +45,9 @@ func main() {
Example usages: Example usages:
- [client_verbose](./examples/client_verbose/) a verbose client show casing the easy to use high level api - [client_verbose](./examples/client_verbose/) a verbose client show casing the easy to use high level api
## tests ## low level api for power users
``` The packages **chunk7, messages7, network7, packer, protocol7** Implement the low level 0.7 teeworlds protocol. Use them if you want to build something advanced such as a custom proxy.
go test ./...
```
## projects using go-teeworlds-protocol ## projects using go-teeworlds-protocol