Skip to content

Commit f53bde7

Browse files
Update README.md
1 parent 1b2a977 commit f53bde7

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

tls_client/README.md

+17-5
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55

66
## Golang TLS Client SDK
77

8-
[![APItoolkit SDK](https://img.shields.io/badge/APItoolkit-SDK-0068ff?logo=go)](https://github.com/topics/apitoolkit-sdk) [![Join Discord Server](https://img.shields.io/badge/Chat-Discord-7289da)](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) [![APItoolkit Docs](https://img.shields.io/badge/Read-Docs-0068ff)](https://apitoolkit.io/docs/sdks/golang?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) [![GoDoc](https://godoc.org/github.com/apitoolkit/apitoolkit-go?status.svg)](https://godoc.org/github.com/apitoolkit/apitoolkit-go/main/tree/native)
8+
[![APItoolkit SDK](https://img.shields.io/badge/APItoolkit-SDK-0068ff?logo=go)](https://github.com/topics/apitoolkit-sdk) [![Join Discord Server](https://img.shields.io/badge/Chat-Discord-7289da)](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) [![APItoolkit Docs](https://img.shields.io/badge/Read-Docs-0068ff)](https://apitoolkit.io/docs/sdks/golang?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) [![GoDoc](https://godoc.org/github.com/apitoolkit/apitoolkit-go?status.svg)](https://godoc.org/github.com/apitoolkit/apitoolkit-go/tls_client)
99

10-
If you are using a TLS client for your HTTP requests, you will need to use the apitoolkit-go/tls_client package to monitor those requests. To use the package, you must first install it using the command below:
10+
APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. If you are using a TLS client for your HTTP requests, you will need to use the `apitoolkit-go/tls_client` package to monitor those requests, aggregate the requests, and then deliver them to the APItoolkit's servers.
1111

1212
</div>
1313

@@ -30,7 +30,19 @@ Kindly run the command below to install the SDK:
3030
go get github.com/apitoolkit/apitoolkit-go/tls_client
3131
```
3232

33-
Then add `github.com/apitoolkit/apitoolkit-go/tls_client` to the list of dependencies like so:
33+
Then add `github.com/apitoolkit/apitoolkit-go/tls_client` to the list of dependencies, like so:
34+
35+
```go
36+
package main
37+
38+
import (
39+
apitoolkit "github.com/apitoolkit/apitoolkit-go/tls_client"
40+
)
41+
```
42+
43+
## Configuration
44+
45+
Next, initialize APItoolkit in your application's entry point (e.g., `main.go`) like so:
3446

3547
```go
3648
package main
@@ -96,7 +108,7 @@ func main() {
96108

97109
> [!IMPORTANT]
98110
>
99-
> To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read this [SDK documentation](https://apitoolkit.io/docs/sdks/golang/tls_client?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme).
111+
> To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read this [SDK documentation](https://apitoolkit.io/docs/sdks/golang?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme).
100112
101113
## Contributing and Help
102114

@@ -108,7 +120,7 @@ To contribute to the development of this SDK or request help from the community
108120

109121
## License
110122

111-
This repository is published under the [MIT](LICENSE) license.
123+
This repository is published under the [MIT](../LICENSE) license.
112124

113125
---
114126

0 commit comments

Comments
 (0)