aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob Odersky <jakob@odersky.com>2016-01-24 20:21:17 -0800
committerJakob Odersky <jakob@odersky.com>2016-02-03 20:46:28 -0800
commitf865a76c2f441f619b069505b73fcbd1cba1a67c (patch)
tree3f53c519f4575037bdebf8c8399ca25d50649543 /README.md
parent46c30908f827e27b58166f56efa4f15917c1af4f (diff)
downloadakka-serial-f865a76c2f441f619b069505b73fcbd1cba1a67c.tar.gz
akka-serial-f865a76c2f441f619b069505b73fcbd1cba1a67c.tar.bz2
akka-serial-f865a76c2f441f619b069505b73fcbd1cba1a67c.zip
Add support for Akka streams
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/README.md b/README.md
index 60b2623..622fde2 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,8 @@ Serial communication library for Scala, designed to be reactive, lightweight and
- Reactive: only does work when required (no constant polling of ports or blocking IO)
- Integrates seamlessly with Akka
- Portable to POSIX systems
-- Watchable ports: react to connection of new devices
+- Watchable ports: react to connection of new device
+- Compatible with Reactive Streams
## Native side
Since hardware is involved in serial communication, a Scala-only solution is not possible. Nevertherless, the native code is kept simple and minimalistic with the burden of dealing with threads left to Scala. The code aims to be POSIX compliant and therefore easily portable.
@@ -13,17 +14,18 @@ Since hardware is involved in serial communication, a Scala-only solution is not
## Directory Structure
```
flow/
-├── flow-main Main scala source files.
+├── flow-core Main Scala source files.
├── flow-native C sources used to implement serial communication.
├── flow-samples Runnable example projects.
-├── project SBT configuration.
+├── flow-stream Stream API, used to connect with Akka streams.
+├── project Build configuration.
└── site Website sources, including documentation.
```
## Build
-Detailed documentation on building flow is available on the website.
+Detailed documentation on building flow is available on the website (or, equivalently, in [developer.md](site/jekyll/documentation/developer.md)).
-Since flow integrates into the Akka-IO framework, a good resource on its general design is the framework's [documentation](http://doc.akka.io/docs/akka/2.4.1/scala/io.html).
+Since flow integrates into the Akka-IO framework, a good resource on its general design is the framework's [documentation](http://doc.akka.io/docs/akka/2.4.2-RC1/scala/io.html).
This project is also an experiment on working with JNI and automating build infrastructure.