Skip to content

Commit

Permalink
Update README.markdown
Browse files Browse the repository at this point in the history
* Fix small issue with markdown so list enumeration works.
  • Loading branch information
rafael committed Aug 8, 2014
1 parent 6b1aa04 commit c586897
Showing 1 changed file with 20 additions and 16 deletions.
36 changes: 20 additions & 16 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -46,25 +46,29 @@ import DefaultJsonProtocol._ // !!! IMPORTANT, else `convertTo` and `toJson` won
and do one or more of the following:

1. Parse a JSON string into its Abstract Syntax Tree (AST) representation
```scala
val source = """{ "some": "JSON source" }"""
val jsonAst = source.parseJson // or JsonParser(source)
```


```scala
val source = """{ "some": "JSON source" }"""
val jsonAst = source.parseJson // or JsonParser(source)
```

2. Print a JSON AST back to a String using either the `CompactPrinter` or the `PrettyPrinter`
```scala
val json = jsonAst.prettyPrint // or .compactPrint
```


```scala
val json = jsonAst.prettyPrint // or .compactPrint
```

3. Convert any Scala object to a JSON AST using the pimped `toJson` method
```scala
val jsonAst = List(1, 2, 3).toJson
```


```scala
val jsonAst = List(1, 2, 3).toJson
```

4. Convert a JSON AST to a Scala object with the `convertTo` method
```scala
val myObject = jsonAst.convertTo[MyObjectType]
```

```scala
val myObject = jsonAst.convertTo[MyObjectType]
```

In order to make steps 3 and 4 work for an object of type `T` you need to bring implicit values in scope that
provide `JsonFormat[T]` instances for `T` and all types used by `T` (directly or indirectly).
Expand Down

0 comments on commit c586897

Please sign in to comment.