diff options
Diffstat (limited to 'documentation/index.md')
| -rw-r--r-- | documentation/index.md | 32 |
1 files changed, 9 insertions, 23 deletions
diff --git a/documentation/index.md b/documentation/index.md index 2211f8a..e07de2a 100644 --- a/documentation/index.md +++ b/documentation/index.md @@ -8,45 +8,31 @@ title: Documentation Start by reading the manual and checking out some examples. - <i class="fa fa-book"></i> [Manual]({{site.version_docs}}/manual) - Explains how to get started and how to use all features. Definitive guide to using flow. + Explains how to get started and how to use all features. Definitive guide to using akka-serial. -- <i class="fa fa-book"></i> [Examples](https://github.com/jodersky/flow/tree/master/flow-samples) +- <i class="fa fa-book"></i> [Examples](https://github.com/jodersky/akka-serial/tree/master/samples) See some very simple, working demo applications. - <i class="fa fa-book"></i> [Developer Guide]({{site.version_docs}}/developer) - Instructions on building, testing and publishing flow. + Instructions on building, testing and publishing akka-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-code"></i> [API documentation]({{site.version_docs}}/api/index.html#akka.serial.Serial$) + Browse akka-serial's API. ## Help Have a question or suggestion? Found a bug? There are several channels to get help. -- <i class="fa fa-bug"></i> [Issues](https://github.com/jodersky/flow/issues) +- <i class="fa fa-bug"></i> [Issues](https://github.com/jodersky/akka-serial/issues) Check known issues or file a new one. This is also the place to go for long questions or propositions. -- <i class="fa fa-comments"></i> [Chat](https://gitter.im/jodersky/flow) +- <i class="fa fa-comments"></i> [Chat](https://gitter.im/jodersky/akka-serial) Gitter chat for simple inquiries. ## Use cases -Get inspired by some real projects that use flow. +Get inspired by some real projects that use akka-serial. - [Virtual Cockpit](https://github.com/project-condor/mavigator) part of [Project Condor](https://project-condor.github.io/), a do-it-yourself drone. - [Hyperion](https://github.com/mthmulders/hyperion) back-end, part of a web-based energy dashboard for "smart meters". -- [(add yours by opening an issue)](https://github.com/jodersky/flow/issues) - ------ - -## 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). - ------ +- [(add yours by opening an issue)](https://github.com/jodersky/akka-serial/issues) |