Skip to content

Commit 1b11542

Browse files
committed
Update README.md
1 parent fe9099d commit 1b11542

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

+14-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A Java 8 compatibility kit for Scala.
44

5-
### Functional Interfaces for Scala functions
5+
## Functional Interfaces for Scala functions
66

77
A set of [Functional Interfaces](https://docs.oracle.com/javase/8/docs/api/java/lang/FunctionalInterface.html)
88
for `scala.FunctionN`. These are designed for convenient construction of Scala functions
@@ -23,11 +23,22 @@ class Test {
2323

2424
[More Examples / Documentation](src/test/java/scala/compat/java8/LambdaTest.java)
2525

26-
### Converters between `scala.concurrent` and `java.util.concurrent`
26+
## Converters between `scala.concurrent` and `java.util.concurrent`
2727

2828
- [API](src/main/java/scala/compat/java8/FutureConverters.java)
2929
- [Test Cases](src/test/java/scala/compat/java8/FutureConvertersTest.java)
3030

31-
### Future work
31+
## Adding an SBT dependency
32+
To depend on scala-xml in SBT, add something like this to your build.sbt:
33+
34+
```
35+
libraryDependencies += "org.scala-lang.modules" %% "scala-java8-compat" % "0.2.0"
36+
```
37+
38+
Maven users, or sbt users looking to support multiple Scala versions, please see the more elaborate example in https://github.com/scala/scala-module-dependency-sample.
39+
40+
The API is currently still experimental: we do not yet guarantee source or binary compatibility with future releases.
41+
42+
## Future work
3243
- Converters for `java.util.function`, `java.util.stream`
3344
- [`Spliterator`](https://docs.oracle.com/javase/8/docs/api/java/util/Spliterator.html)s for Scala collections

0 commit comments

Comments
 (0)