aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJason Zaugg <jzaugg@gmail.com>2016-09-08 16:07:28 +1000
committerGitHub <noreply@github.com>2016-09-08 16:07:28 +1000
commit92147d80ba9190fbc342a222b8a43d07d5976135 (patch)
tree465d223d41e60a8e5dd0d42a97c7e28150ece35d /README.md
parent567ca8b1ca24c497c3a75e1d17609cca9d636a62 (diff)
parent9633048443c7adcb16fec460c174f958b291213c (diff)
downloadscala-async-92147d80ba9190fbc342a222b8a43d07d5976135.tar.gz
scala-async-92147d80ba9190fbc342a222b8a43d07d5976135.tar.bz2
scala-async-92147d80ba9190fbc342a222b8a43d07d5976135.zip
Merge pull request #142 from knoldus/topic/doc-improvementv0.9.6-RC4
Add dependency information for including in project.
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index d9afa2f..68a27c4 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,24 @@ Note: this branch targets Scala 2.11.x, support for Scala 2.10.x has been moved
## Quick start
+To include scala-async in an existing project use the library published on Maven Central.
+For sbt projects add the following to your build definition - build.sbt or project/Build.scala:
+
+```scala
+libraryDependencies += "org.scala-lang.modules" %% "scala-async" % "0.9.5"
+```
+
+For Maven projects add the following to your <dependencies> (make sure to use the correct Scala version prefix, _2.10 or _2.11,
+to match your project’s Scala version):
+
+```scala
+<dependency>
+ <groupId>org.scala-lang.modules</groupId>
+ <artifactId>scala-async_2.11</artifactId>
+ <version>0.9.5</version>
+</dependency>
+```
+
After adding a scala-async to your classpath, write your first `async` block:
```scala