Skip to content

Commit cdb6623

Browse files
committed
docs: 📚 updates documentation
Signed-off-by: Lucas Vieira <lucas.engen.cc@gmail.com>
1 parent bc13a67 commit cdb6623

File tree

1 file changed

+43
-6
lines changed

1 file changed

+43
-6
lines changed

README.md

Lines changed: 43 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ A simple library to get WarThunder data provided by the localhost server
1313
go get -u github.com/lucasvmx/WarTelemetry/telemetry
1414
```
1515

16-
## Example
16+
## Example (localhost)
17+
1718
```go
1819
package main
1920

@@ -26,21 +27,57 @@ import (
2627
)
2728

2829
func main() {
29-
// Not needed if war thunder is running on localhost
30-
wartelemetry.Initialize("192.168.1.35")
30+
// Use this to collect data from remote computer
31+
wartelemetry.InitializeRemote("192.168.1.35")
32+
33+
// Enable internal debug logging (disabled by default)
34+
logger.EnableDebug()
35+
36+
for {
37+
38+
data, err := wartelemetry.GetTelemetryData()
39+
if err != nil {
40+
log.Printf("failed to collect data: %v", err)
41+
time.Sleep(time.Second * 3)
42+
continue
43+
} else {
44+
log.Printf("Aircraft Name: %v", data.Indicators.AircraftName)
45+
}
46+
}
47+
}
48+
49+
```
50+
51+
## Example (Remote Host)
52+
53+
```go
54+
55+
package main
56+
57+
import (
58+
"log"
59+
"time"
60+
61+
"github.com/lucasvmx/WarTelemetry/logger"
62+
wartelemetry "github.com/lucasvmx/WarTelemetry/telemetry"
63+
)
64+
65+
func main() {
66+
// Use this for localhost
67+
wartelemetry.InitializeLocalHost()
3168

32-
// Enable internal debug logging (disabled by default)
69+
// Enable internal debug logging (disabled by default)
3370
logger.EnableDebug()
3471

3572
for {
3673

37-
t, err := wartelemetry.GetTelemetryData()
74+
data, err := wartelemetry.GetTelemetryData()
3875
if err != nil {
3976
log.Printf("failed to collect data: %v", err)
4077
time.Sleep(time.Second * 3)
4178
continue
4279
} else {
43-
log.Printf("Aircraft Name: %v", t.Indicators.AircraftName)
80+
log.Printf("Aircraft Name: %v", data.Indicators.AircraftName)
4481
}
4582
}
4683
}

0 commit comments

Comments
 (0)