Преглед изворни кода

Add use, example to README

Signed-off-by: Ashley Mills <ashleymills@mac.com>
Ashley Mills пре 11 година
родитељ
комит
802242097e
1 измењених фајлова са 31 додато и 4 уклоњено
  1. 31 4
      README.md

+ 31 - 4
README.md

@@ -1,5 +1,4 @@
-Reachability.swift
-==================
+# Reachability.swift
 
 Replacement for Apple's Reachability re-written in Swift with callbacks
 
@@ -7,7 +6,35 @@ Inspired by https://github.com/tonymillion/Reachability
 
 NOTE:
 
-As of Swift 1.1, you cannot convert Swift closures into C-function pointers, meaning we can't set an SCNetworkReachabilityCallBack.
+As of Swift 1.1, you cannot convert Swift closures into C-function pointers, meaning we can't set an `SCNetworkReachabilityCallBack`.
 
-To get around this, this reachability replacement uses an NSTimer firing at 1/2 second intervals.
+To get around this, this reachability replacement uses an `NSTimer` firing at 1/2 second intervals.
+
+## Use
+
+Just drop the **Reachability.swift** file into your project. That's it!
+
+## Example
+
+    let reachability = Reachability.reachabilityForInternetConnection()
+
+    reachability.reachableBlock = { reachability in
+        if reachability.isReachableViaWiFi() {
+            println("\(Reachable via WiFi)")
+        } else {
+            println("\(Reachable via Cellular)")
+        }
+    }
+    reachability.unreachableBlock = { reachability in
+        println("\(Not reachable)")
+    }
+
+    reachability.startNotifier()
+
+## Let me know
+
+If you use **Reachability.swift**, please let me know… and tell your friends! 
+
+Cheers,
+Ash