Merge branch 'master' of github.com:ZackMcBride/MultiMagic

README.md

@@ -1,24 +1,126 @@
-# MultiMagic
+# MultiMagic - Magic Multipeer Connectivity
 
 [![Version](http://cocoapod-badges.herokuapp.com/v/MultiMagic/badge.png)](http://cocoadocs.org/docsets/MultiMagic)
 [![Platform](http://cocoapod-badges.herokuapp.com/p/MultiMagic/badge.png)](http://cocoadocs.org/docsets/MultiMagic)
 
+A very simple wrapper for the iOS7 Multipeer Connectivity framework. 
+
+## Installation
+
+~~MultiMagic is available through [CocoaPods](http://cocoapods.org), to install
+it simply add the following line to your Podfile:~~
+
+I haven't gotten round to submitting this to Cocoapods yet, so for now you can install this by adding the following code to your Podfile:
+```
+   pod 'MultiMagic',	:git => "[email protected]:ZackMcBride/MultiMagic.git", :tag => 'v0.0.2' 
+```
+
+and then running ```pod install``` from your project directory.
+
 ## Usage
 
-To run the example project; clone the repo, and run `pod install` from the Example directory first.
+### Creating a session
 
-## Requirements
+Getting started is easy. Just write
 
-## Installation
+```objective-c
+[MultiMagic.manager startSessionWithName:[UIDevice currentDevice].name
+                                 visible:YES];
+```
+
+### Browsing available devices
+
+1. Set your current view controller as the browser delegate
+
+```objective-c
+    MultiMagic.manager.browser.delegate = self;
+```
+
+2. Present the browser
+
+```objective-c
+    [self presentViewController:MultiMagic.manager.browser 
+                       animated:YES 
+                     completion:nil];
+```
+
+This will enable the default iOS modal viewController for connecting with peers.
+
+### Listening for session changes
+
+1. Implement this block (it's probably good to do this at the same time that you start the session)
+
+```objective-c
+    MultiMagic.manager.onSessionDidChangeState = ^(MMState *state){
+        // Do some good stuff here...
+    };
+```
+
+This will fire whenever something changes in your session
+
+### Receiving things
+
+Use these blocks to interact with all that multipeer goodness
+
+```objective-c
+@property (nonatomic, copy) void (^onSessionDidReceiveData)(MMData *data);
+```
+
+This will get called whenever data is received from another peer. You receive an MMData instance which holds the message.
+
+
+```objective-c
+@property (nonatomic, copy) void (^onSessionDidReceiveStream)(MMStream *stream);
+```
+
+This will get called when a nearby peer opens a stream to your device. The MMStream object you receive contains an NSInputStream.
+
+
+```objective-c
+@property (nonatomic, copy) void (^onSessionDidStartReceivingResource)(MMResource *resource);
+```
+
+Indicates that you have begun receiving a resource from another peer. This instance of MMResource holds an NSProgress object.
+
+
+```objective-c
+@property (nonatomic, copy) void (^onSessionDidFinishReceivingResource)(MMResource *resource);
+```
+
+Indicates that the stream you have been receiving just finished. It contains an NSURL object pointing to the brand new local file stored on your device.
 
-MultiMagic is available through [CocoaPods](http://cocoapods.org), to install
-it simply add the following line to your Podfile:
+### Sending things
 
-    pod "MultiMagic"
+  ***Simple data***
+
+  ```objective-c
+    [MultiMagic.manager.session sendData:(NSData *)data 
+                                 toPeers:(NSArray *)peerIDs 
+                                withMode:(MCSessionSendDataMode)mode 
+                                   error:(NSError **)error;
+  ```
+  
+  ***Files***
+  
+  ```objective-c
+    [MultiMagic.manager.session sendResourceAtURL:(NSURL *)resourceURL 
+                                         withName:(NSString *)resourceName 
+                                           toPeer:(MCPeerID *)peerID
+                            withCompletionHandler:(void(^)(NSError *error))completionHandler;
+  ```
+
+  ***Streams***
+
+  ```objective-c
+    [MultiMagic.manager.session startStreamWithName:(NSString *)streamName 
+                                             toPeer:(MCPeerID *)peerID 
+                                              error:(NSError **)error;
+  ```
+Hopefully you get the idea. Have fun!
 
 ## Author
 
-Zack McBride, zmcbride@shopkeep.com
+Zack McBride, zackmcbride@gmail.com
 
 ## License