Skip to content

Commit b917928

Browse files
authored
Add README (#4)
1 parent 67e5795 commit b917928

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# palworld-rcon
2+
[![GitHub Build](https://github.com/invliD/palworld-rcon/actions/workflows/go.yml/badge.svg?branch=master)](https://github.com/invliD/palworld-rcon/actions)
3+
[![Go Report Card](https://goreportcard.com/badge/github.com/invliD/palworld-rcon)](https://goreportcard.com/report/github.com/invliD/palworld-rcon)
4+
[![Go Reference](https://pkg.go.dev/badge/github.com/invliD/palworld-rcon.svg)](https://pkg.go.dev/github.com/invliD/palworld-rcon)
5+
6+
## Install
7+
```shell
8+
go get github.com/invliD/palworld-rcon
9+
```
10+
11+
## Usage
12+
```go
13+
package main
14+
15+
import (
16+
"fmt"
17+
"log"
18+
19+
palworldrcon "github.com/invliD/palworld-rcon"
20+
)
21+
22+
func main() {
23+
client := palworldrcon.NewClient("127.0.0.1:25575", "password")
24+
25+
info, err := client.Info()
26+
if err != nil {
27+
log.Fatal(err)
28+
}
29+
30+
fmt.Printf("Connected to server '%s' running version %s!\n", info.ServerName, info.Version)
31+
}
32+
```
33+
34+
## License
35+
MIT License, see [LICENSE](LICENSE)

0 commit comments

Comments
 (0)