From c2afba8b84e441505d9ef0a38281f62c6fe8eb63 Mon Sep 17 00:00:00 2001 From: shangcr Date: Mon, 27 Apr 2020 20:49:16 +0800 Subject: [PATCH] MOD: update readme and fix typo Change-Id: I9d10ad8f2f9b5876311868dd1bc3ff92aa7db829 --- README.md | 9 ++++++--- YTKNetwork/YTKBaseRequest.h | 8 ++++---- YTKNetwork/YTKBatchRequest.h | 2 +- YTKNetwork/YTKChainRequest.h | 2 +- YTKNetwork/YTKNetworkAgent.m | 2 +- YTKNetwork/YTKNetworkPrivate.m | 2 +- 6 files changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 609c5a5..14ba180 100644 --- a/README.md +++ b/README.md @@ -54,16 +54,17 @@ To use YTKNetwork add the following to your Podfile Or add this in your Cartfile: - github "yuantiku/YTKNetwork" ~> 2.0 + github "yuantiku/YTKNetwork" ~> 3.0 ## Requirements | YTKNetwork Version | AFNetworking Version | Minimum iOS Target | Note | |:------------------:|:--------------------:|:-------------------:|:-----| +| 3.x | 4.x | iOS 9 | Xcode 11+ is required. | | 2.x | 3.x | iOS 7 | Xcode 7+ is required. | | 1.x | 2.x | iOS 6 | n/a | -YTKNetwork is based on AFNetworking. You can find more detail about version compability at [AFNetworking README](https://github.com/AFNetworking/AFNetworking). +YTKNetwork is based on AFNetworking. You can find more detail about version compatibility at [AFNetworking README](https://github.com/AFNetworking/AFNetworking). ## Guide & Demo @@ -77,6 +78,7 @@ YTKNetwork is based on AFNetworking. You can find more detail about version comp * [veecci][veecciGithub] * [tangqiaoboy][tangqiaoboyGithub] * [skyline75489][skyline75489Github] + * [joeshang][joeshangGithub] ## Acknowledgements @@ -84,7 +86,7 @@ YTKNetwork is based on AFNetworking. You can find more detail about version comp * [AFDownloadRequestOperation] Thanks for their great work. -  + ## License YTKNetwork is available under the MIT license. See the LICENSE file for more info. @@ -103,3 +105,4 @@ YTKNetwork is available under the MIT license. See the LICENSE file for more inf [maojjGithub]:https://github.com/maojj [veecciGithub]:https://github.com/veecci [skyline75489Github]:https://github.com/skyline75489 +[joeshangGithub]:https://github.com/joeshang diff --git a/YTKNetwork/YTKBaseRequest.h b/YTKNetwork/YTKBaseRequest.h index 8d110e9..83375fc 100644 --- a/YTKNetwork/YTKBaseRequest.h +++ b/YTKNetwork/YTKBaseRequest.h @@ -202,7 +202,7 @@ typedef void(^YTKRequestCompletionBlock)(__kindof YTKBaseRequest *request); /// will be called on the main queue. @property (nonatomic, copy, nullable) YTKRequestCompletionBlock failureCompletionBlock; -/// This can be used to add several accossories object. Note if you use `addAccessory` to add acceesory +/// This can be used to add several accessories object. Note if you use `addAccessory` to add accessory /// this array will be automatically created. Default is nil. @property (nonatomic, strong, nullable) NSMutableArray> *requestAccessories; @@ -259,7 +259,7 @@ typedef void(^YTKRequestCompletionBlock)(__kindof YTKBaseRequest *request); /// @name Subclass Override ///============================================================================= -/// Called on background thread after request succeded but before switching to main thread. Note if +/// Called on background thread after request succeeded but before switching to main thread. Note if /// cache is loaded, this method WILL be called on the main thread, just like `requestCompleteFilter`. - (void)requestCompletePreprocessor; @@ -284,14 +284,14 @@ typedef void(^YTKRequestCompletionBlock)(__kindof YTKBaseRequest *request); /// Otherwise the result URL may not be correctly formed. See also `URLString:relativeToURL` /// for more information. /// -/// Additionaly, if `requestUrl` itself is a valid URL, it will be used as the result URL and +/// Additionally, if `requestUrl` itself is a valid URL, it will be used as the result URL and /// `baseUrl` will be ignored. - (NSString *)requestUrl; /// Optional CDN URL for request. - (NSString *)cdnUrl; -/// Requset timeout interval. Default is 60s. +/// Request timeout interval. Default is 60s. /// /// @discussion When using `resumableDownloadPath`(NSURLSessionDownloadTask), the session seems to completely ignore /// `timeoutInterval` property of `NSURLRequest`. One effective way to set timeout would be using diff --git a/YTKNetwork/YTKBatchRequest.h b/YTKNetwork/YTKBatchRequest.h index 7a50dfe..1080055 100644 --- a/YTKNetwork/YTKBatchRequest.h +++ b/YTKNetwork/YTKBatchRequest.h @@ -69,7 +69,7 @@ NS_ASSUME_NONNULL_BEGIN /// Tag can be used to identify batch request. Default value is 0. @property (nonatomic) NSInteger tag; -/// This can be used to add several accossories object. Note if you use `addAccessory` to add acceesory +/// This can be used to add several accessories object. Note if you use `addAccessory` to add acceesory /// this array will be automatically created. Default is nil. @property (nonatomic, strong, nullable) NSMutableArray> *requestAccessories; diff --git a/YTKNetwork/YTKChainRequest.h b/YTKNetwork/YTKChainRequest.h index 3e5bb5e..1bc06c3 100644 --- a/YTKNetwork/YTKChainRequest.h +++ b/YTKNetwork/YTKChainRequest.h @@ -62,7 +62,7 @@ typedef void (^YTKChainCallback)(YTKChainRequest *chainRequest, YTKBaseRequest * /// The delegate object of the chain request. Default is nil. @property (nonatomic, weak, nullable) id delegate; -/// This can be used to add several accossories object. Note if you use `addAccessory` to add acceesory +/// This can be used to add several accessories object. Note if you use `addAccessory` to add acceesory /// this array will be automatically created. Default is nil. @property (nonatomic, strong, nullable) NSMutableArray> *requestAccessories; diff --git a/YTKNetwork/YTKNetworkAgent.m b/YTKNetwork/YTKNetworkAgent.m index 6c54fd8..9e788fe 100755 --- a/YTKNetwork/YTKNetworkAgent.m +++ b/YTKNetwork/YTKNetworkAgent.m @@ -126,7 +126,7 @@ - (NSString *)buildRequestUrl:(YTKBaseRequest *)request { baseUrl = [_config baseUrl]; } } - // URL slash compability + // URL slash compatibility NSURL *url = [NSURL URLWithString:baseUrl]; if (baseUrl.length > 0 && ![baseUrl hasSuffix:@"/"]) { diff --git a/YTKNetwork/YTKNetworkPrivate.m b/YTKNetwork/YTKNetworkPrivate.m index 3b25ec3..3376f90 100755 --- a/YTKNetwork/YTKNetworkPrivate.m +++ b/YTKNetwork/YTKNetworkPrivate.m @@ -149,7 +149,7 @@ + (BOOL)validateResumeData:(NSData *)data { return [[NSFileManager defaultManager] fileExistsAtPath:localFilePath]; #endif // After iOS 9 we can not actually detects if the cache file exists. This plist file has a somehow - // complicated structue. Besides, the plist structure is different between iOS 9 and iOS 10. + // complicated structure. Besides, the plist structure is different between iOS 9 and iOS 10. // We can only assume that the plist being successfully parsed means the resume data is valid. return YES; }