diff options
| author | Jakob Odersky <jakob@odersky.com> | 2016-06-09 03:48:30 -0700 |
|---|---|---|
| committer | Jakob Odersky <jakob@odersky.com> | 2016-06-09 03:48:30 -0700 |
| commit | ee29b1c22dd0930a3c6e51c0fe93f588f499df10 (patch) | |
| tree | 62687a3deb5f49ab3a28807c061004f527979aeb | |
| parent | 796974f5d328c50b079630663a66ebaed3f68b1a (diff) | |
| download | akka-serial-ee29b1c22dd0930a3c6e51c0fe93f588f499df10.tar.gz akka-serial-ee29b1c22dd0930a3c6e51c0fe93f588f499df10.tar.bz2 akka-serial-ee29b1c22dd0930a3c6e51c0fe93f588f499df10.zip | |
update site
| -rw-r--r-- | _config.yml | 4 | ||||
| -rw-r--r-- | documentation/index.md | 17 |
2 files changed, 18 insertions, 3 deletions
diff --git a/_config.yml b/_config.yml index 5b07096..d4f1f1c 100644 --- a/_config.yml +++ b/_config.yml @@ -2,5 +2,5 @@ title: flow description: Serial communication library for Akka and Scala. url: "https://www.jodersky.ch/flow" -version_latest: 2.6.0 -version_docs: 2.6 +version_latest: 3.0.0 +version_docs: 3.0 diff --git a/documentation/index.md b/documentation/index.md index db36470..7143b5f 100644 --- a/documentation/index.md +++ b/documentation/index.md @@ -3,6 +3,21 @@ layout: page title: Documentation --- ## Documentation + +----- + +### NOTICE: Upgrading from 2.0 to 3.0 + +The latest release, 3.0.0, introduces some compatibility-breaking changes: + +- Organization and packages have been changes 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 istaled the native library, you will also need to install libflow4 (see the Developer Guide for more information). + +----- + Start by reading the manual and checking out some examples. - <i class="fa fa-book"></i> [Manual]({{site.version_docs}}/manual) @@ -11,7 +26,7 @@ Start by reading the manual and checking out some examples. - <i class="fa fa-book"></i> [Examples](https://github.com/jodersky/flow/tree/master/flow-samples) See some very simple, working demo applications. -- <i class="fa fa-code"></i> [API documentation]({{site.version_docs}}/api/index.html#com.github.jodersky.flow.Serial$) +- <i class="fa fa-code"></i> [API documentation]({{site.version_docs}}/api/index.html#ch.jodersky.flow.Serial$) Browse flow's API. - <i class="fa fa-book"></i> [Developer Guide]({{site.version_docs}}/developer) |