Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
magiconair committed Dec 5, 2024
1 parent 4f26d0f commit 564489b
Showing 1 changed file with 6 additions and 19 deletions.
25 changes: 6 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,6 @@ See below for a list of [Tested Platforms](#tested-platforms) and [Supported Fea
[![License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/gopcua/opcua/blob/master/LICENSE)
[![Version](https://img.shields.io/github/tag/gopcua/opcua.svg?color=blue&label=version)](https://github.com/gopcua/opcua/releases)

## v0.5.x BREAKING CHANGES

* `v0.5.0` released on 14 Aug 2023: all `Client` methods must have a context
* `v0.5.1` released on 22 Aug 2023: the `NewClient` function returns an error

In `v0.3.0` on 21 Jan 2022 release we added `WithContext` variants for all methods
to avoid a breaking change. All existing methods without a context had a disclaimer
that with `v0.5.0` their signature would change to include the context
and that the `WithContext` method would be removed.

We missed to update the `NewClient` function in `v0.5.0` which was fixed
in `v0.5.1`.

Please update your code and let us know if there are any issues!

Thank you!

Your GOPCUA Team

## Quickstart

```sh
Expand All @@ -57,6 +38,12 @@ go run examples/crypto/*.go -endpoint opc.tcp://localhost:4840 -cert path/to/cer
# checkout examples/ for more examples...
```

## List of Breaking Changes

* `v0.6.0`: The `SelectEndpoint` function in the client now returns an error (#753)
* `v0.5.1`: the `NewClient` function returns an error
* `v0.5.0`: all `Client` methods must have a context

## Sponsors

The `gopcua` project is sponsored by the following organizations by supporting the active committers to the project:
Expand Down

0 comments on commit 564489b

Please sign in to comment.