aboutsummaryrefslogtreecommitdiff
path: root/documentation/3.0/manual.md
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/3.0/manual.md')
-rw-r--r--documentation/3.0/manual.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/documentation/3.0/manual.md b/documentation/3.0/manual.md
index 3cc5545..ff23d1e 100644
--- a/documentation/3.0/manual.md
+++ b/documentation/3.0/manual.md
@@ -6,6 +6,20 @@ title: User Guide
* TOC
{:toc}
+-----
+
+## Migrating from 2.x to 3.x
+
+The latest major release, 3, introduces some source compatibility-breaking changes:
+
+- Organization and packages have been changed from `com.github.jodersky` to `ch.jodersky`
+- A new major version of the native library has been released, `libflow4`
+
+It should be sufficient to change any imports that previously used "com.github.jodersky.flow" to "ch.jodersky.flow".
+In case you manually installed the native library, you will also need to upgrade to libflow4 (see the Developer Guide for more information).
+
+-----
+
# Getting Started
Flow uses sbt as build system. To get started, include a dependency to flow in your project: