From b917928586894c037f1dd0dd68653e97986f9d85 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebastian=20Br=C3=BCckner?= <code@nik.dev>
Date: Sun, 18 Feb 2024 08:31:36 +0000
Subject: [PATCH] Add README (#4)

---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7f68ddd
--- /dev/null
+++ b/README.md
@@ -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)