diff options
| author | Mathias <mathias@spray.cc> | 2011-07-06 10:10:06 +0200 |
|---|---|---|
| committer | Mathias <mathias@spray.cc> | 2011-07-06 10:10:06 +0200 |
| commit | bb9ea8dd6d00ae3a1d9df64da693603d3aa53083 (patch) | |
| tree | 894193a38169f7fd3dca04c9df9867c004524ec5 | |
| parent | 83c85a54e59da47cb9659dba42fcf001b06d631d (diff) | |
| download | spray-json-bb9ea8dd6d00ae3a1d9df64da693603d3aa53083.tar.gz spray-json-bb9ea8dd6d00ae3a1d9df64da693603d3aa53083.tar.bz2 spray-json-bb9ea8dd6d00ae3a1d9df64da693603d3aa53083.zip | |
Update README
| -rw-r--r-- | README.markdown | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/README.markdown b/README.markdown index cb10113..aa19d51 100644 --- a/README.markdown +++ b/README.markdown @@ -12,14 +12,14 @@ It sports the following features: _spray-json_ is available from the [scala-tools.org][] repositories. There is no official release yet, but the current snapshot is `1.0-SNAPSHOT`. -It is built against Scala 2.9.0, but backporting to 2.8.1 is no problem (let me know if you need a 2.8.1 compatible version). +It is built against Scala 2.9.0-1, but backporting to 2.8.1 is no problem (let me know if you need a 2.8.1 compatible version). If you use SBT you can include _spray-json_ in your project with val sprayJsonModuleConfig = ModuleConfiguration("cc.spray.json", ScalaToolsSnapshots) val sprayJson = "cc.spray.json" %% "spray-json" % "1.0.0-SNAPSHOT" % "compile" withSources() -_spray-json_ has only one dependency: the parsing library [parboiled][] (which is also a dependency of _spray-server_ and _spray_client_, so if you use _spray-json_ with either of them you are not incurring any additional dependency). +_spray-json_ has only one dependency: the parsing library [parboiled][] (which is also a dependency of _spray-server_ and _spray-client_, so if you use _spray-json_ with either of them you are not incurring any additional dependency). ### Usage @@ -70,9 +70,12 @@ Here are the types already taken care off by the `DefaultJsonProtocol`: * Byte, Short, Int, Long, Float, Double, Char, Unit, Boolean * String, Symbol * BigInt, BigDecimal -* Option, Tuple1 - Tuple7 -* List, Array, immutable.Map, immutable.Set, mutable.Set - +* Option, Either, Tuple1 - Tuple7 +* List, Array +* immutable.{Map, Iterable, Seq, IndexedSeq, LinearSeq, Set, Vector} +* collection.{Iterable, Seq, IndexedSeq, LinearSeq, Set} +* JsValue + In most cases however you'll also want to convert types not covered by the `DefaultJsonProtocol`. In these cases you need to provide `JsonFormat[T]`s for your custom types. This is not hard at all. |