Skip to content

Commit 9aafea6

Browse files
committed
docs: updating the readme to note the v2 api changes
1 parent d4ef23b commit 9aafea6

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,14 @@
1010
go get -u go.devnw.com/bk/v2@latest
1111
```
1212

13+
## Version 2 Changes
14+
15+
Version 2 changes the API for Bridgekeeper to using a direct function literal
16+
in the `New` function so that it can accept both the `Do` and `RoundTrip`
17+
functions from the `http.Client` and `http.Transport` respectively. This
18+
allows for Bridgekeeper to support connections where a custom `http.Transport`
19+
is may be required, for example, when using a custom TLS configuration.
20+
1321
### HTTP Client Example
1422

1523
```go

0 commit comments

Comments
 (0)