Update README

Author: indulgeIn

README.md

@@ -1 +1,98 @@
-# YBModelFile
+# YBModelFile (Latest version : 1.0)
+
+iOS 效率工具：自动生成 Model 文件（数据模型） / iOS efficiency tool : create data model files automatically
+
+技术原理博客：TODO
+
+
+## 特性
+
+- 一句代码自动生成数据模型文件
+- 支持 YYModel / MJExtension 的自动映射
+- 自动过滤转换类名和属性名
+- 自动实现 NSCopying / NSCoding 协议方法
+- 支持文件创建策略：一个类一组文件或并为一组文件
+- 支持属性类型的过滤策略
+- 算法处理模块粒度小且面向协议，可自由定制局部算法
+
+
+
+## 安装
+
+### CocoaPods
+
+1. 在 Podfile 中添加 `pod 'YBModelFile'`。
+2. 执行 `pod install` 或 `pod update`。
+3. 导入 `<YBModelFile/YBModelFile.h>`。
+
+### 手动导入
+
+1. 下载 YBModelFile 文件夹所有内容并且拖入你的工程中。
+2. 导入 `YBModelFile.h`。
+
+
+## 用法
+
+可下载 DEMO 查看示例。
+
+### 基本使用
+
+```objc
+NSString *name = ...;   //主 Model 文件名字
+id data = ...;          //json数据
+[YBModelFile createFileWithName:name data:data];
+```
+一句代码调用过后，工具会自动在桌面上创建一个 YBModelFile-Workspace 文件夹，之后所有自动创建的 Model 文件会存储在该文件夹下，只需要将它们拖入工程就能直接使用。
+
+当然，可以使用`-createFileWithName:data:path:`方法中的`path`指定工作空间的存储路径。
+
+### 字典转模型框架设置
+
+由于工具会自动进行属性和数组元素的映射，你需要指定工程使用的字典转模型框架，目前支持 YYModel 和 MJExtension。
+```objc
+[YBMFConfig shareConfig].framework = YBMFFrameworkYY;
+```
+
+### NSCoding 和 NSCopying 协议
+
+NSCoding 和 NSCopying 协议是否实现可以指定：
+```objc
+[YBMFConfig shareConfig].needCoding = NO;
+[YBMFConfig shareConfig].needCopying = NO;
+```
+
+### 属性和方法之间是否空行
+
+工具提供简单的定制：
+```objc
+[YBMFConfig shareConfig].fileHHandler.ybmf_skipLine = YES;
+[YBMFConfig shareConfig].fileMHandler.ybmf_skipLine = YES;
+```
+
+### 类名公用后缀
+
+默认情况下，类名公用后缀为`Model`，可以自行定制：
+```objc
+[YBMFConfig shareConfig].fileSuffix = @"File";
+```
+
+### 属性忽略类型
+
+在构建 Model 时，往往需要过滤掉一些类型，比如需要使用`NSString`提到`NSNumber`，过滤掉字典中的可变类型。这些都可以通过一个多选枚举来配置，过滤的类型工具会使用更宽泛的类型来处理。
+```objc
+[YBMFConfig shareConfig].ignoreType = YBMFIgnoreTypeAllDigital | YBMFIgnoreTypeMutable;
+```
+
+### 文件划分策略
+
+目前支持两种策略，一种是所有类都放到一组文件 (.h/.m)，一种是一个类对应一组文件：
+```objc
+[YBMFConfig shareConfig].filePartitionMode = YBMFFilePartitionModeApart;
+```
+
+
+# TODO
+
+通常情况下，该工具使用比较顺手，但是会有一些问题：
+- json 嵌套过深，类名过长：工具目前是使用 json 的 key 来拓展拼接类名的，所以 json 套得越深类名越长。后面考虑两种处理方法，一是限制类名长度，二是使用与 key 无关的类名拓展策略，不过显而易见每种方式都有缺陷。
+- 文件拆分粒度控制：目前工具支持要么合并为一组文件，要么完全分开。考虑在复杂场景下，可能需要按需拆分，比如 100 model 类需要划分为 10 组 .h/.m 文件。目前能想到的是三种方式：一是对关系树按照层级划分文件，在一层的类划分到一个文件，这种处理方式的缺点是一个文件的所有类是兄弟节点没有什么逻辑关联，不便于管理；二是通过设置一个最大层级来控制，比如设置的层级是 3，那么第 3 层之后的子节点类都合并到第 3 层的类文件中；三是在深搜过程中记录文件中的类数量，一个文件达到数量限制就创建新的文件来写入类。

YBModelFile.podspec

@@ -5,9 +5,10 @@ Pod::Spec.new do |s|
 
   s.name         = "YBModelFile"
   s.version      = "1.0"
-  s.summary      = "iOS Model 自动生成工具 (数据模型)"
+  s.summary      = "iOS 效率工具：自动生成 Model 文件（数据模型） /  iOS efficiency tool : create data model files automatically"
   s.description  = <<-DESC
-  					iOS Model 自动生成工具 (数据模型)，只需传入一个 json 数据就能自动生成所需文件，拖入工程就能使用。
+  					iOS 效率工具：自动生成 Model 文件（数据模型） /  iOS efficiency tool : create data model files automatically
+            只需传入一个 json 数据就能自动生成所需文件，拖入工程就能使用。
                    DESC
 
   s.homepage     = "https://github.com/indulgeIn"
@@ -18,9 +19,9 @@ Pod::Spec.new do |s|
 
   s.platform     = :ios, "8.0"
 
-  s.source       = { :git => "https://github.com/indulgeIn/YBTaskScheduler.git", :tag => "#{s.version}" }
+  s.source       = { :git => "https://github.com/indulgeIn/YBModelFile.git", :tag => "#{s.version}" }
 
-  s.source_files = "YBModelFile/**/*.{h,m,mm}"
+  s.source_files = "YBModelFile/**/*.{h,m}"
 
   s.requires_arc = true
 

YBModelFile/Handler/YBMFNameHandler.m

@@ -192,7 +192,7 @@ - (NSString *)ybmf_propertyNameWithKey:(id)key node:(nonnull YBMFNode *)node {
     NSSet *illegalVars = YBClassVarsExceptPrefix([YBMFConfig shareConfig].baseClass);
     while ([node.children.allKeys containsObject:tmp] || [illegalVars containsObject:tmp]) {
         tmp = keyStr.copy;
-        tmp = [tmp stringByAppendingString:[NSString stringWithFormat:@"%lu", ++suf]];
+        tmp = [tmp stringByAppendingString:[NSString stringWithFormat:@"%lu", (unsigned long)++suf]];
     }
     return tmp;
 }

YBModelFile/YBModelFile.m

@@ -166,7 +166,7 @@ - (NSString *)creatDirectoryWithPath:(NSString *)path directoryName:(NSString *)
     if (exist && cover) return directoryPath;
     NSUInteger suffix = 0;
     while (exist) {
-        directoryPath = [path stringByAppendingPathComponent:[NSString stringWithFormat:@"%@%lu", directoryName, ++suffix]];
+        directoryPath = [path stringByAppendingPathComponent:[NSString stringWithFormat:@"%@%lu", directoryName, (unsigned long)++suffix]];
         exist = [[NSFileManager defaultManager] fileExistsAtPath:directoryPath];
     }
     NSError *error;