Convert Readme to asciidoc

Author: Frizlab

Readme.md Readme.adocReadme.md renamed to Readme.adoc

@@ -1,30 +1,32 @@
-# BSONSerialization
+= BSONSerialization
 BSON Serialization in native Swift
 
-## Installation & Compatibility
+== Installation & Compatibility
 The recommended (and only tested) way to install and use BSONSerialization is
-via `SwiftPM`, using at least Swift 4.
+via `SwiftPM`, using at least Swift 5.1.
 
 The content of your `Package.swift` should be something resembling:
-```swift
+[source,swift]
+----
 import PackageDescription
 
 let package = Package(
 	name: "MyAwesomePackage",
 	dependencies: [.package(url: "https://github.com/Frizlab/BSONSerialization.git", from: "2.0.0")]
 )
-```
+----
 
-## Usage
+== Usage
 `BSONSerialization` has the same basic interface than `JSONSerialization`.
 
 Example of use:
-```swift
+[source,swift]
+----
 let myFirstBSONDoc = ["key": "value"]
 let serializedBSONDoc = try BSONSerialization.data(withBSONObject: myFirstBSONDoc, options: [])
 let unserializedBSONDoc = try BSONSerialization.bsonObject(with: serializedBSONDoc, options: [])
 try areBSONDocEqual(myFirstBSONDoc, unserializedBSONDoc) /* Returns true */
-```
+----
 
 Serializing/deserializing to/from a stream is also supported. (Note: Due to the
 specifications of the BSON format, serializing to a Data object is faster than
@@ -33,7 +35,7 @@ serializing to a stream.)
 Finally, a method lets you know if a given dictionary can be serialized as a
 BSON document.
 
-## Alternatives
+== Alternatives
 First, a word about the philosophy of this project. Most BSON frameworks create
 a whole new type to represent the BSON document. This is useful to add new
 elements to the documents and have the document serialization ready at all times.
@@ -47,21 +49,21 @@ If you prefer having an actual BSON object to which you can add elements
 instead of standard Foundation object which are serialized later, I would
 recommend this project: https://github.com/OpenKitten/BSON
 
-## Reference
+== Reference
 I used the BSON specification version 1.1 from http://bsonspec.org/spec.html
 
 All types in this specification, including deprecated ones are supported.
 
-## To Do
-- [ ] Allow direct serialization of `Data` object instead of having to use the
+== To Do
+* [ ] Allow direct serialization of `Data` object instead of having to use the
 `MongoBinary` type
-- [ ] Allow serializing Int64 or Int32 to Int directly, depending on the platform
-- [ ] Xcode target for an iOS Framework
+* [ ] Allow serializing Int64 or Int32 to Int directly, depending on the platform
+* [ ] Xcode target for an iOS Framework
 
 I’ll work seriously on the project if it gains enough attention. Feel free to
 open issues, I’ll do my best to answer.
 
 Pull requests are welcome 😉
 
-## License
+== License
 MIT (see License.txt file)