Update README.md

deda9 · Jul 17, 2019 · 2ad8d4a · 2ad8d4a
1 parent b1737a7
commit 2ad8d4a
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,27 @@
 # WaitUntil
+
+Its a sugar syntax to use expectation to run asynchronous work on XCTestCase.
+
+#### It replaces:
+```Swift
+let imageLoader = ImageLoader()
+let completedExpectation = expectation(description: "Completed")
+
+imageLoader.download { image in
+    completedExpectation.fulfill()
+}
+
+waitForExpectations(timeout: 0.3, handler: nil)
+
+```
+
+#### with:
+```Swift
+let imageLoader = ImageLoader()
+
+waitUnilt { done in
+    imageLoader.download { image in
+        done()
+    }
+}
+```