Skip to content

Commit

Permalink
docs: updating the readme to note the v2 api changes
Browse files Browse the repository at this point in the history
  • Loading branch information
benjivesterby committed Nov 15, 2024
1 parent d4ef23b commit 9aafea6
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@
go get -u go.devnw.com/bk/v2@latest
```

## Version 2 Changes

Version 2 changes the API for Bridgekeeper to using a direct function literal
in the `New` function so that it can accept both the `Do` and `RoundTrip`
functions from the `http.Client` and `http.Transport` respectively. This
allows for Bridgekeeper to support connections where a custom `http.Transport`
is may be required, for example, when using a custom TLS configuration.

### HTTP Client Example

```go
Expand Down

0 comments on commit 9aafea6

Please sign in to comment.