Skip to content

Commit f809ce8

Browse files
committed
Add notice in readme about incoming API changes
Link to #42 and #54
1 parent 6bd8412 commit f809ce8

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,15 @@ The core C#/.NET binding API (FoundationDB.Client namespace) is relatively stabl
1313

1414
[![Build status](https://ci.appveyor.com/api/projects/status/83u4pd2ckevdtb57?svg=true)](https://ci.appveyor.com/project/KrzysFR/foundationdb-dotnet-client)
1515

16+
__Notice: read this first!__
17+
18+
19+
> __There is an incoming API change that may break a few things, regarding the use of Subspaces and Tuples__. The new API is currently in the `refac_tuples` branch, and will be merge soon in `master` for the 0.9 release. If you are just starting, you should probably use the new branch. If you already have existing code, there will be a document explaining the changes and how to fix your source code. __See [#42](https://github.com/Doxense/foundationdb-dotnet-client/pull/42) for more details.__
20+
21+
> __There is another incoming change, regarding the way FDB's Futures are implemented under the hood, which should fix some random crash issues under heavy load__. Some of the problems have already been fixed in master, but the new branch `future_ng` is a complete rework, in collaboration with the folks at FoundationDB. __See [#54](https://github.com/Doxense/foundationdb-dotnet-client/pull/54) for more details__
22+
23+
> Both these branches are already used in production. Once everything is merged and tested, we will be ready for 1.0.
24+
1625
How to use
1726
----------
1827

0 commit comments

Comments
 (0)