aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJason Zaugg <jzaugg@gmail.com>2015-07-06 12:32:52 +1000
committerJason Zaugg <jzaugg@gmail.com>2015-07-06 12:32:52 +1000
commit00e62b26430bd3e79424499de50c80d582e1b28e (patch)
tree544ff95a725a9518206e11fb5e786b65b49108b8 /README.md
parent1568a28842e2c538ca735a34274ae5e4ee5eca22 (diff)
downloadscala-async-00e62b26430bd3e79424499de50c80d582e1b28e.tar.gz
scala-async-00e62b26430bd3e79424499de50c80d582e1b28e.tar.bz2
scala-async-00e62b26430bd3e79424499de50c80d582e1b28e.zip
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 3 insertions, 12 deletions
diff --git a/README.md b/README.md
index a3abe57..0f5c730 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,10 @@
-# Scala Async Project
-
-[![Build Status](https://secure.travis-ci.org/scala/async.png)](http://travis-ci.org/scala/async)
+# scala-async [<img src="https://img.shields.io/travis/scala/async.svg"/>](https://travis-ci.org/scala/async) [<img src="https://img.shields.io/maven-central/v/org.scala-lang.modules/scala-async_2.10.svg?label=latest%20release%20for%202.10"/>](http://search.maven.org/#search%7Cga%7C1%7Cg%3Aorg.scala-lang.modules%20a%3Ascala-async_2.10) [<img src="https://img.shields.io/maven-central/v/org.scala-lang.modules/scala-async_2.11*.svg?label=latest%20release%20for%202.11"/>](http://search.maven.org/#search%7Cga%7C1%7Cg%3Aorg.scala-lang.modules%20a%3Ascala-async_2.11*)
Note: this branch targets Scala 2.11.x, support for Scala 2.10.x has been moved to [this branch](https://github.com/scala/async/tree/2.10.x).
## Quick start
-Add a dependency:
-
-```scala
-// SBT
-libraryDependencies += "org.scala-lang.modules" %% "scala-async" % "0.9.2"
-```
-
-Write your first `async` block:
+After adding a scala-async to your classpath, write your first `async` block:
```scala
import ExecutionContext.Implicits.global
@@ -146,6 +137,6 @@ difficult to understand.
- See the [neg](https://github.com/scala/async/tree/master/src/test/scala/scala/async/neg) test cases for
for constructs that are not allowed in a async block
- See the [issue list](https://github.com/scala/async/issues?state=open) for which of these restrictions are planned
- to be dropped in the next milestone.
+ to be dropped in the future.
- See [#13](https://github.com/scala/async/issues/13) for why `await` is not possible in closures, and for suggestions on
ways to structure the code to work around this limitation.