Skip to content

Commit ae42518

Browse files
committed
modify readme for v4.0.1
1 parent cfa14be commit ae42518

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,13 @@ We use the following versioning model:
4141

4242
So if you depend on the master branch, you can expect breakages from time
4343
to time. If you need something that doesn't change in a backward-compatible
44-
way you should use have a `go.mod` file in the directory where your
44+
way you should use a `go.mod` file in the directory where your
4545
main package is.
4646

47-
In the current state of v4.0.1-alpha.1, some backward-incompatible changes with v3 were made.
48-
These incompatibilities are being addressed with the help of the `go.dedis.ch/kyber-test` repo,
49-
which contains tests that will be run against kyber v4 to ensure compatibility with kyber v3.
47+
In v4.0.1 modifications to certain structures where introduced making compatibility between v3 and v4 nodes not
48+
straight forward. We recommend carefully reviewing the new structures to adapt marshaling methods in sytems where
49+
nodes of different versions interact. For instance, a structure might have had a field type changed from `int`
50+
to `int32` in v4.
5051

5152
Using the module
5253
----------------
@@ -71,7 +72,7 @@ func main() {
7172
}
7273
```
7374
2. Type “go mod init example.com/ex”. The resulting go.mod file will have no dependencies listed yet.
74-
3. Type “go build”. The go tool will fill in the new dependencies that it find for you, i.e. "require go.dedis.ch/kyber/v4 v4.0.1-alpha.1”.
75+
3. Type “go build”. The go tool will fill in the new dependencies that it find for you, i.e. "require go.dedis.ch/kyber/v4 v4.0.1”.
7576
4. Running `./ex` will print `0000000000000000000000000000000000000000000000000000000000000000`.
7677

7778
A note on deriving shared secrets

0 commit comments

Comments
 (0)