diff --git a/Road-toward-3.0.0.md b/Road-toward-3.0.0.md new file mode 100644 index 0000000..f96717e --- /dev/null +++ b/Road-toward-3.0.0.md @@ -0,0 +1,16 @@ +# Overview + +This library follows the [Semantic Versioning Specification](http://semver.org). The last released library version was [version 2.1.1](https://github.com/nlohmann/json/releases/tag/v2.1.1). In the last months, several changes and bug fixes have been proposed that would break the public API. As a result, they could not be merged into the 2.x.x version family. These changes will be addressed with [version 3.0.0](https://github.com/nlohmann/json/milestone/5). + +In case of bugs, there may be another 2.x.x release. However, pushing forward version 3.0.0 has a priority. + +# Branches + +- The [`master`](https://github.com/nlohmann/json/tree/master) branch contains the code of version 2.1.1. This branch should be seen as **stable** in the sense that it not will not be touched until the next release. +- The [`develop`](https://github.com/nlohmann/json/tree/develop) branch will be the place where the transition toward version 3.0.0 will happen. This branch is **unstable**. This branch will soon contain code that is incompatible to the 2.x.x version. That is, existing code may not compile with this library version. + +:warning: Please **do not** use the `develop` branch for productive use. + +# Changes + +This section shall list the changes that have been made past version 2.1.1. If possible, we shall provide examples how to change existing tools to work with the 3.0.0 release. \ No newline at end of file