Skip to content
This repository was archived by the owner on Jun 10, 2021. It is now read-only.

Commit ada0995

Browse files
committed
Add readme
1 parent 2a2cf9e commit ada0995

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

build.sbt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name := "asyncstreams"
22

3-
version := "1.0"
3+
version := "0.1"
44

55
scalaVersion := "2.11.8"
66

readme.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
asyncstreams [![Release](https://jitpack.io/v/danslapman/asyncstreams.svg)](https://jitpack.io/#danslapman/asyncstreams)
2+
=========
3+
4+
asyncstreams is a monadic asynchronous stream library. It allows you to write stateful asynchronous algorithms
5+
that emits elements into a stream:
6+
7+
```scala
8+
val stream = generateS(0) {
9+
for {
10+
s <- getS[Int]
11+
if s < 3
12+
_ <- putS(s + 1)
13+
} yield s
14+
}
15+
16+
wait(stream.to[List]) shouldBe (0 :: 1 :: 2 :: Nil)
17+
```
18+
19+
See more examples in tests.

0 commit comments

Comments
 (0)