Skip to content

Commit 5e1a151

Browse files
committed
Update README.md
1 parent 829903b commit 5e1a151

File tree

1 file changed

+2
-10
lines changed

1 file changed

+2
-10
lines changed

README.md

+2-10
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,17 @@ Maintainer wanted!
22
==================
33
Would you like to maintain this project? (Please open an issue/send an email!)
44

5-
scala-xml [<img src="https://api.travis-ci.org/scala/scala-xml.png"/>](https://travis-ci.org/scala/scala-xml)
5+
scala-xml [<img src="https://img.shields.io/travis/scala/scala-xml.svg"/>](https://travis-ci.org/scala/scala-xml) [<img src="https://img.shields.io/maven-central/v/org.scala-lang.modules/scala-xml_2.11.svg?label=latest%20release%20for%202.11"/>](http://search.maven.org/#search%7Cga%7C1%7Cg%3Aorg.scala-lang.modules%20a%3Ascala-xml_2.11) [<img src="https://img.shields.io/maven-central/v/org.scala-lang.modules/scala-xml_2.12*.svg?label=latest%20release%20for%202.12"/>](http://search.maven.org/#search%7Cga%7C1%7Cg%3Aorg.scala-lang.modules%20a%3Ascala-xml_2.12*)
66
=========
77

88
The standard Scala XML library. Please file issues here instead of over at issues.scala-lang.org.
99

1010
As of Scala 2.11, this library is a separate jar that can be omitted from Scala projects that do not use XML.
11+
If you are cross-building a project that uses scala-xml with Scala 2.10 and Scala 2.11, take a look [this example](https://github.com/scala/scala-module-dependency-sample).
1112

1213
The compiler was decoupled from this particular implementation using the same approach as for comprehensions (xml syntax is desugared into a set of method calls, which unfortunately is only defined by the [implementation](https://github.com/scala/scala/blob/2.11.x/src/compiler/scala/tools/nsc/ast/parser/SymbolicXMLBuilder.scala)). Alternative implementations are welcome!
1314

1415
API documentation is available [here](http://www.scala-lang.org/api/current/scala-xml/).
1516

1617
## Security best practices
1718
The XML spec has some features that are best turned off, to avoid unsavory things like file system access, DoS attacks,... Issue [#17](https://github.com/scala/scala-xml/issues/17) tracks the recommended way of configuring the xml parser used by scala-xml to avoid these. This is by no means an exhaustive list. We'll be happy to incorporate your suggestions -- just comment on the ticket!
18-
19-
## Adding an SBT dependency
20-
To depend on scala-xml in SBT, add something like this to your build.sbt:
21-
22-
```
23-
libraryDependencies += "org.scala-lang.modules" %% "scala-xml" % "1.0.4"
24-
```
25-
26-
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.

0 commit comments

Comments
 (0)