aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSatendra kumar <satendra@knoldus.com>2015-09-25 12:22:21 +0530
committerSatendra kumar <satendra@knoldus.com>2015-09-25 12:22:21 +0530
commit9633048443c7adcb16fec460c174f958b291213c (patch)
tree77789d0b33230fda1f233974b1568f4979df48fc
parent7263aaad02a75978a0a48f90bf171c66cda4328c (diff)
downloadscala-async-9633048443c7adcb16fec460c174f958b291213c.tar.gz
scala-async-9633048443c7adcb16fec460c174f958b291213c.tar.bz2
scala-async-9633048443c7adcb16fec460c174f958b291213c.zip
Add dependency information for including in project.
Added dependency information for Maven and SBT so that it is easier for the developers who are new to the library.
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0f5c730..5351773 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