Skip to content

Commit

Permalink
Add README (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
invliD authored Feb 18, 2024
1 parent 67e5795 commit b917928
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# palworld-rcon
[![GitHub Build](https://github.com/invliD/palworld-rcon/actions/workflows/go.yml/badge.svg?branch=master)](https://github.com/invliD/palworld-rcon/actions)
[![Go Report Card](https://goreportcard.com/badge/github.com/invliD/palworld-rcon)](https://goreportcard.com/report/github.com/invliD/palworld-rcon)
[![Go Reference](https://pkg.go.dev/badge/github.com/invliD/palworld-rcon.svg)](https://pkg.go.dev/github.com/invliD/palworld-rcon)

## Install
```shell
go get github.com/invliD/palworld-rcon
```

## Usage
```go
package main

import (
"fmt"
"log"

palworldrcon "github.com/invliD/palworld-rcon"
)

func main() {
client := palworldrcon.NewClient("127.0.0.1:25575", "password")

info, err := client.Info()
if err != nil {
log.Fatal(err)
}

fmt.Printf("Connected to server '%s' running version %s!\n", info.ServerName, info.Version)
}
```

## License
MIT License, see [LICENSE](LICENSE)

0 comments on commit b917928

Please sign in to comment.