From 51ab1c523a27a1bf5b8d1452b37d7e332011c3b0 Mon Sep 17 00:00:00 2001 From: Seth Tisue Date: Thu, 28 Sep 2017 14:26:04 -0700 Subject: [PATCH] various readme tweaks I wanted to get rid of the JIRA link, but then did extra girl/boy-scouting --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ebec79812..a0c4d66b1 100644 --- a/README.md +++ b/README.md @@ -6,18 +6,21 @@ scala-xml [![Gitter](https://badges.gitter.im/Join+Chat.svg)](https://gitter.im/scala/scala-xml) ========= -The standard Scala XML library. Please file issues here instead of over at issues.scala-lang.org. +The standard Scala XML library. Please file XML issues here, not at https://github.com/scala/bug/issues. Since Scala 2.11, this library is a separate jar that can be omitted from Scala projects that do not use XML. -If you are cross-building a project that uses scala-xml with both Scala 2.10 and later Scala versions, take a look [this example](https://github.com/scala/scala-module-dependency-sample). -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! +The decoupling works because the compiler desugars XML literals in Scala source code into a set of method calls. Alternative implementations of these calls are welcome! (The calls are unfortunately only defined by the [implementation](https://github.com/scala/scala/blob/2.11.x/src/compiler/scala/tools/nsc/ast/parser/SymbolicXMLBuilder.scala).) API documentation is available [here](http://www.scala-lang.org/api/current/scala-xml/scala/xml/index.html). +## Cross-building with 2.10 + +If you are cross-building a project that uses scala-xml with both Scala 2.10 and later Scala versions, take a look at [this example](https://github.com/scala/scala-module-dependency-sample). + ## Maintenance status -This library is community-maintained. The lead maintainers are [@biswanaths](https://github.com/biswanaths) and [@aaron_s_hawley](https://github.com/ashawley). +This library is community-maintained. The lead maintainers are [@aaron_s_hawley](https://github.com/ashawley) and [@biswanaths](https://github.com/biswanaths). ## Security best practices