Skip to content

Commit

Permalink
Updates to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tristanhimmelman authored Sep 14, 2016
1 parent 3ad489f commit 680f5cd
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,10 @@ ObjectMapper is a framework written in Swift that makes it easy for you to conve
- Struct support

# The Basics
To support mapping, a class or struct just needs to implement the ```Mappable``` protocol.
To support mapping, a class or struct just needs to implement the ```Mappable``` protocol which includes the following functions:
```swift
public protocol Mappable {
init?(_ map: Map)
mutating func mapping(map: Map)
}
init?(_ map: Map)
mutating func mapping(map: Map)
```
ObjectMapper uses the ```<-``` operator to define how each member variable maps to and from JSON.

Expand Down Expand Up @@ -91,7 +89,7 @@ Convert a model object to a JSON string:
let JSONString = user.toJSONString(prettyPrint: true)
```

Alternatively, the `Mapper.swift` class can also be used to accomplish the above (it also provides extra functionality for more other situations):
Alternatively, the `Mapper.swift` class can also be used to accomplish the above (it also provides extra functionality for other situations):
```
// Convert JSON String to Model
let user = Mapper<User>().map(JSONString: JSONString)
Expand Down

0 comments on commit 680f5cd

Please sign in to comment.