Update README.md.

Author: kevin-lyn

README.md

@@ -1,40 +1,42 @@
 # STNetTaskQueue
-Queue for managing network requests
+STNetTaskQueue is a networking queue library for iOS and OS X. It's abstract and can be implemented in different protocols.
 
-STNetTaskQueue may be your choice if you want to handle each network request stuff in separated STNetTask instead of having all the network requests logics in a "Manager" class.
+STNetTaskQueue avoid you from directly dealing with "url", "request packing" and "response parsing". All networking tasks are described and processed by subclassing STNetTask, which provides you a clean code style in UI layer when handling networking.
 
-**STHTTPNetTaskQueueHandler** is included, which is for HTTP based network reqeust. If you are looking for a socket or other protocol based handler, currently you should write your own net task queue handler and conform to **STNetTaskQueueHandler** protocol. **STHTTPNetTaskQeueuHandler** depends on [AFNetworking](https://github.com/AFNetworking/AFNetworking), which is included in example project.
+## STHTTPNetTaskQueueHandler
 
-## Features
-- Retry net task with specified max retry count.
-- Delegate for net task result according to "uri" of net task.
-- More features are coming as STNetTaskQueue is extendible.
+STHTTPNetTaskQueueHandler is a HTTP based implementation of STNetTaskQueueHandler. It provides different ways to pack request and parse response, e.g. STHTTPNetTaskRequestJSON is for JSON format request body, STHTTPNetTaskResponseJSON is for JSON format response data and STHTTPNetTaskRequestFormData is for form data format request body which is mostly used for uploading file.
 
-## Sequence Chart
-![STNetTaskQueue Sequence Chart](https://cloud.githubusercontent.com/assets/1491282/7292210/6d761f6a-e9cc-11e4-9620-0075082dcc8e.png)
+## STNetTask
 
-## Get Started
+STNetTask is abstract, it provides basic properties and callbacks for subclassing.
+
+## STNetTaskDelegate
+
+STNetTaskDelegate is the delegate protocol for observing result of STNetTask, mostly it is used in view controller. 
 
-### Installation with CocoaPods
+## STNetTaskChain
 
-[CocoaPods](http://cocoapods.org) is a dependency manager for Objective-C, which automates and simplifies the process of using 3rd-party libraries like AFNetworking in your projects. See the ["Getting Started" guide for more information](https://github.com/AFNetworking/AFNetworking/wiki/Getting-Started-with-AFNetworking).
+STNetTaskChain is a chain which processes an array of STNetTask serially. A net task chain is considered as successful only if all net tasks in the chain are end without error.
+
+## Get Started
 
-#### Podfile
+### Podfile
 
 ```ruby
 platform :ios, '7.0'
-pod 'STNetTaskQueue', '~> 0.0.1'
+pod 'STNetTaskQueue', '~> 0.0.2'
 ```
 
-
+### Use STNetTaskQueue in your project
 #### Step 1: Setup STNetTaskQueue after your app launch
 ```objc
 NSURL *baseUrl = [NSURL URLWithString:@"http://api.openweathermap.org"];
 STHTTPNetTaskQueueHandler *httpHandler = [[STHTTPNetTaskQueueHandler alloc] initWithBaseURL:baseUrl];
 [STNetTaskQueue sharedQueue].handler = httpHandler;
 ```
 
-#### Step 2: Write your net task for each reqeust
+#### Step 2: Create your net task
 ```objc
 @interface STOpenWeatherNetTask : STHTTPNetTask
 
@@ -61,7 +63,7 @@ STHTTPNetTaskQueueHandler *httpHandler = [[STHTTPNetTaskQueueHandler alloc] init
 
 - (NSUInteger)maxRetryCount
 {
-    return 3;
+    return 3; // Retry after error occurs
 }
 
 - (NSDictionary *)parameters
@@ -79,25 +81,28 @@ STHTTPNetTaskQueueHandler *httpHandler = [[STHTTPNetTaskQueueHandler alloc] init
 @end
 ```
 
-#### Step 3: Go and get your response
+#### Step 3: Send net task and delegate for the result
 ```objc
-if (_openWeatherTask.pending) {
-    return;
+- (void)sendOpenWeatherTask
+{
+    if (_openWeatherTask.pending) {
+        return;
+    }
+    _openWeatherTask = [STOpenWeatherNetTask new];
+    _openWeatherTask.latitude = @"1.306038";
+    _openWeatherTask.longitude = @"103.772962";
+    // Task delegate will be a weak reference, so there is no need to remove it manually.
+    // It's appropriate to add task delegate here because duplicated task delegates will be ignored by STNetTaskQueue.
+    [[STNetTaskQueue sharedQueue] addTaskDelegate:self uri:_openWeatherTask.uri];
+    [[STNetTaskQueue sharedQueue] addTask:_openWeatherTask];
 }
-_openWeatherTask = [STOpenWeatherNetTask new];
-_openWeatherTask.latitude = @"1.306038";
-_openWeatherTask.longitude = @"103.772962";
-// Task delegate will be a weak reference, so no need to remove it manually.
-// Duplicated task delegates will be ignored by STNetTaskQueue, so it's fine to invoke addTaskDelegate here.
-[[STNetTaskQueue sharedQueue] addTaskDelegate:self uri:_openWeatherTask.uri];
-[[STNetTaskQueue sharedQueue] addTask:_openWeatherTask];
 ```
 
 ```objc
 - (void)netTaskDidEnd:(STNetTask *)task
 {
-    // It's necessary to detect if _openWeatherTask != task and return,
-    // if you have mutiple instance/viewController deleagating the same uri.
+    // It's necessary to detect if _openWeatherTask != task,
+    // if you have mutiple viewControllers deleagating the same uri.
     if (_openWeatherTask != task) {
         return;
     }
@@ -112,5 +117,10 @@ _openWeatherTask.longitude = @"103.772962";
     _goBtn.hidden = YES;
 }
 ```
+For more details, download the example project or check out unit tests for usage references.
+
+## What's Next
 
-You can see more details in example project. The example is tested with iOS SDK 8.1, XCode 6.1.1 and iPhone 6 simulator.
+- More unit tests for STHTTPNetTaskQueueHandler.
+- Detailed documentation for STNetTaskQueue, STNetTask, STNetTaskChain.
+- Support other protocol based STNetTaskQueueHandler, e.g. STNetTaskQueueHandler for ProtocolBuffers.

STNetTaskQueue/STNetTask.h

@@ -10,6 +10,14 @@
 
 FOUNDATION_EXPORT NSString *const STNetTaskUnknownError;
 
+@class STNetTask;
+
+@protocol STNetTaskDelegate <NSObject>
+
+- (void)netTaskDidEnd:(STNetTask *)task;
+
+@end
+
 @interface STNetTask : NSObject
 
 @property (nonatomic, strong) NSError *error;

STNetTaskQueue/STNetTaskQueue.h

@@ -11,12 +11,6 @@
 
 @class STNetTaskQueue;
 
-@protocol STNetTaskDelegate <NSObject>
-
-- (void)netTaskDidEnd:(STNetTask *)task;
-
-@end
-
 @protocol STNetTaskQueueHandler <NSObject>
 
 - (void)netTaskQueue:(STNetTaskQueue *)netTaskQueue task:(STNetTask *)task taskId:(int)taskId;

STNetTaskQueueExample/STNetTaskQueueExample/STOpenWeatherNetTask.m

@@ -20,6 +20,11 @@ - (NSString *)uri
     return @"data/2.5/weather";
 }
 
+- (NSUInteger)maxRetryCount
+{
+    return 3; // Retry after error occurs
+}
+
 - (NSDictionary *)parameters
 {
     NSLog(@"Pack request parameters");

STNetTaskQueueExample/STNetTaskQueueExample/ViewController.m

@@ -42,23 +42,28 @@ - (void)viewDidLoad
 }
 
 - (void)goBtnDidTap
+{
+    [self sendOpenWeatherTask];
+}
+
+- (void)sendOpenWeatherTask
 {
     if (_openWeatherTask.pending) {
         return;
     }
     _openWeatherTask = [STOpenWeatherNetTask new];
     _openWeatherTask.latitude = @"1.306038";
     _openWeatherTask.longitude = @"103.772962";
-    // Task delegate will be a weak reference, so no need to remove it manually.
-    // Duplicated task delegates will be ignored by STNetTaskQueue, so it's fine to invoke addTaskDelegate here.
+    // Task delegate will be a weak reference, so there is no need to remove it manually.
+    // It's appropriate to add task delegate here because duplicated task delegates will be ignored by STNetTaskQueue.
     [[STNetTaskQueue sharedQueue] addTaskDelegate:self uri:_openWeatherTask.uri];
     [[STNetTaskQueue sharedQueue] addTask:_openWeatherTask];
 }
 
 - (void)netTaskDidEnd:(STNetTask *)task
 {
-    // It's necessary to detect if _openWeatherTask != task and return,
-    // if you have mutiple instance/viewController deleagating the same uri.
+    // It's necessary to detect if _openWeatherTask != task,
+    // if you have mutiple viewControllers deleagating the same uri.
     if (_openWeatherTask != task) {
         return;
     }