README added

Author: makoni

README.md

@@ -1,3 +1,113 @@
 # couchdb-vapor
 
-A description of this package.
+This is simple lib to work with CouchDB with Vapor Framework.
+
+## Installation
+
+### Swift Package Manager
+
+Add to the `dependencies` value of your `Package.swift`.
+
+#### Swift 5
+
+```swift
+dependencies: [
+	.package(url: "https://github.com/makoni/couchdb-vapor.git", from: "0.0.4"),
+]
+```
+
+## Usage
+
+Get data In Vapor routes:
+
+```swift
+let couchDBClient = CouchDBClient()
+
+// Sample document model
+struct ExpectedDoc: Codable {
+	var name: String
+	var _id: String
+	var _rev: String
+}
+
+// Sample view data
+struct PageData: Content {
+	let title: String
+}
+
+/// Register your application's routes here.
+public func routes(_ router: Router) throws {
+	router.get(String.parameter) { req -> Future<View> in
+		let docId = req.parameters.next(String.self)
+		
+		let response = try couchDBClient.get(dbName: "yourDBname", uri: docId, worker: req)?.wait()
+		
+		// response data is in response!.body.data!
+		guard let data = response?.body.data else {
+			throw Abort(.notFound)
+		}
+		
+		// Decode data
+		let decoder = JSONDecoder()
+		let doc = try decoder.decode(ExpectedDoc.self, from: data)
+		
+		let pageData = PageData(
+			title: doc.name
+		)
+		
+		return try req.view().render("view-name", pageData)
+	}
+}
+```
+
+Insert data example:
+
+```swift
+let testData = [name: "some name"]
+
+let encoder = JSONEncoder()
+let data = try encoder.encode(testData)
+
+let response = try couchDBClient.insert(dbName: "yourDBname", body: HTTPBody(data: data), worker: req)?.wait()
+print(response)
+// prints: CouchDBClient.CouchUpdateResponse(ok: true, id: "0a1eea865fdec7a00afb96685001c7be", rev: "1-e6bde9e60844ba5648cc61b446f9f4b3"))
+```
+
+Update data example:
+
+```swift
+let updatedData = ExpectedDoc(name: "some new name", _id: "0a1eea865fdec7a00afb96685001c7be", _rev: "1-e6bde9e60844ba5648cc61b446f9f4b3")
+
+let encoder = JSONEncoder()
+let data = try encoder.encode(testData)
+
+let response = try couchDBClient.update(dbName: "yourDBname", uri: updatedData._id, body: HTTPBody(data: data), worker: req)?.wait()
+print(response)
+// prints: CouchDBClient.CouchUpdateResponse(ok: true, id: "0a1eea865fdec7a00afb96685001c7be", rev: "1-e6bde9e60844ba5648cc61b446f9f4b4"))
+```
+
+Delete data example:
+
+```swift
+let updatedData = ExpectedDoc(name: "some new name", _id: "0a1eea865fdec7a00afb96685001c7be", _rev: "1-e6bde9e60844ba5648cc61b446f9f4b4")
+
+let encoder = JSONEncoder()
+let data = try encoder.encode(testData)
+
+let response = try couchDBClient.delete(fromDb: "yourDBname", uri: updatedData._id, rev: updatedData._rev, worker: req)?.wait()
+print(response)
+// prints: CouchDBClient.CouchUpdateResponse(ok: true, id: "0a1eea865fdec7a00afb96685001c7be", rev: "1-e6bde9e60844ba5648cc61b446f9f4b5"))
+```
+
+Get all DBs example:
+
+```swift
+
+let response = try couchDBClient.getAllDBs(worker: req).wait()
+guard let dbs = response else {
+	throw Abort(.notFound)
+}
+
+print(dbs)
+// prints: ["_global_changes", "_replicator", "_users", "yourDBname"]
+```