aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob Odersky <jakob@odersky.com>2017-01-08 21:16:25 +0100
committerJakob Odersky <jakob@odersky.com>2017-01-21 17:22:10 -0800
commit23959966760174477a6b0fcbf9dd1e8ef37c643b (patch)
tree9a0ee44eb43a8c13af57b0d06313f3aabf9e4555 /README.md
parent6c371ba6d69c891c1f0d6df00bb643e1d543cc9d (diff)
downloadakka-serial-23959966760174477a6b0fcbf9dd1e8ef37c643b.tar.gz
akka-serial-23959966760174477a6b0fcbf9dd1e8ef37c643b.tar.bz2
akka-serial-23959966760174477a6b0fcbf9dd1e8ef37c643b.zip
Rename project to akka-serial
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 18 insertions, 14 deletions
diff --git a/README.md b/README.md
index 9a53ee8..cf37fd8 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
-[![Build Status](https://travis-ci.org/jodersky/flow.svg?branch=master)](https://travis-ci.org/jodersky/flow)
-[![Download](https://img.shields.io/maven-central/v/ch.jodersky/flow-native.svg?maxAge=2592000)](http://search.maven.org/#search|ga|1|ch.jodersky%20flow-)
+[![Build Status](https://travis-ci.org/jodersky/akka-serial.svg?branch=master)](https://travis-ci.org/jodersky/akka-serial)
+[![Download](https://img.shields.io/maven-central/v/ch.jodersky/akka-serial-native.svg?maxAge=2592000)](http://search.maven.org/#search|ga|1|ch.jodersky%20akka-serial-)
-# flow
-Serial communication library for Scala, designed to be reactive, lightweight and easily integrable with Akka applications. See the [website](https://jodersky.github.io/flow) for a guide.
+# akka-serial
+Serial communication library for Scala, designed to be reactive, lightweight and easily integrable with Akka applications. See the [website](https://jodersky.github.io/akka-serial) for a guide.
## Highlights
- Reactive: only does work when required (no constant polling of ports or blocking IO)
@@ -16,25 +16,29 @@ Since hardware is involved in serial communication, a Scala-only solution is not
## Directory Structure
```
-flow/
+akka-serial/
├── Documentation Sources for user documentation as published on the website.
+├── core Main Scala source files.
├── dev Firmware samples for serial devices, to make testing easier.
-├── flow-core Main Scala source files.
-├── flow-native C sources used to implement serial communication.
-│ └── lib_native Compiled native libraries that are published in flow-native.
-├── flow-samples Runnable example projects.
-├── flow-stream Stream API, used to connect with Akka streams.
-└── project Build configuration.
+├── native C sources used to implement serial communication.
+│ └── lib_native Compiled native libraries that are published in the fat jar.
+├── project Build configuration.
+├── samples Runnable example projects.
+├── stream Stream API, used to connect with Akka streams.
+└── sync Synchronous, non-Akka-dependent code.
```
*Website source code is in the git branch 'gh-pages'.*
## Build
-Detailed documentation on building flow is available on the website (or, equivalently, in [developer.md](Documentation/developer.md)).
+Detailed documentation on building akka-serial is available on the website (or, equivalently, in [developer.md](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/current/scala/io.html).
+Since akka-serial integrates into the Akka-IO framework, a good resource on its general design is the framework's [documentation](http://doc.akka.io/docs/akka/current/scala/io.html).
This project is also an experiment on working with JNI and automating build infrastructure.
## Copying
-flow is released under the terms of the 3-clause BSD license. See LICENSE for details.
+akka-serial is released under the terms of the 3-clause BSD license. See LICENSE for details.
+
+## Notes
+This project used to called "flow". It was renamed to "akka-serial".