add en readme

README.md

@@ -1,23 +1,26 @@
 # SmartCropper
 
-简单易用的智能图片裁剪库，适用于身份证，名片，文档等照片的裁剪。 欢迎 start，fork。
+## [English](README_EN.md) | 中文
+
+简单易用的智能图片裁剪库，适用于身份证，名片，文档等照片的裁剪。 如果觉得还不错，欢迎 start，fork。
 
 ## 支持特性
 
-- 使用智能算法识别图片中的边框  
-- 支持拖动锚点，手动调节选区(支持放大镜效果)  
-- 使用透视变换裁剪并矫正选区
+- 使用智能算法(基于opencv)识别图片中的边框  
+- 支持拖动锚点，手动调节选区，放大镜效果提升定位体验
+- 使用透视变换裁剪并矫正选区，还原正面图片
+- 支持丰富的UI设置，如辅助线，蒙版，锚点，放大镜等
+
+## 例子（[传送门](art/SmartCropperSampleV5.apk)）
 
-## 例子
-下载Demo：[传送门](art/SmartCropperSampleV5.apk)
+![](art/download_qr.png)
 
-### 智能选区，透视变换裁剪并矫正选区：
+### 1. 选择图片后智能选区，使用透视变换裁剪并矫正选区：
 
 ![](art/smart_crop_1.png)
 ![](art/cropped_1.png)
 
-
-### 拖动锚点，手动调节选区（右上角放大镜效果方便拖拽）：
+### 2. 拖动锚点，手动调节选区，右上角放大镜效果方便拖拽定位：
 
 ![](art/advance_crop_1.png)
 
@@ -26,70 +29,88 @@
 ![](art/smartcropper_photo.gif)
 ![](art/smartcropper_album.gif)
 
-
 ## 接入
 
-可以直接依赖 aar 文件夹下的 aar 文件，也可以 clone 项目，将 smartcropperlib 作为 Android 模块导入。之后有需要的话可以上传到仓库。   
-另外根目录 libs 目录下是编译好的 native library，如果引入项目不想编译，可以直接使用。
+可以直接依赖 aar 文件夹下的 aar 文件，也可以 clone 项目，将 smartcropperlib 作为 Android 模块导入。
+另外 libs 目录下是编译好的 native library，如果引入项目不想编译，可以直接使用。（JCenter 仓库地址之后提供）
 
-注意：由于使用了 JNI， 所以**不要混淆**
+注意：由于使用了 JNI， 请**不要混淆**  
+
+```
+-keep class me.pqpo.smartcropperlib.**{*;}
+```  
 
 ## 使用  
 
-### 1. 布局：  
+### 1. 裁剪布局：  
 ```xml
 <me.pqpo.smartcropperlib.view.CropImageView   
         android:id="@+id/iv_crop"  
         android:layout_width="match_parent" 
         android:layout_height="match_parent" />  
 ```  
 
+注意： CropImageView 继承至 ImageView，但是 ScaleType 必须为居中类型，如果手动设置成 fit_end,fit_start,matrix 将会报错。  
+
 ### 2. 智能选区：    
 
 ```java  
 Point[] points = SmartCropper.scan(selectedBitmap);    
 ```  
-在 native 层智能识别边框，返回的 points 是大小为4的数组，表示选区边框的四个顶点，依次为左上，右上，右下，左下。 
+在 native 层智能识别边框，返回的 points 是大小为4的数组，表示选区边框的四个顶点，依次为左上，右上，右下，左下。   
+
+注意：如果识别失败将返回一个大小为4，内容均为空的数组。该方法主要在 native 层实现，大大的提高了运行效率，运行时间与图片大小成正比，在大图片的情况下，可以考虑在子线程执行，或者压缩传入的图片。  
 
-### 3. 设置给 CropImageView 展示
+### 3. 设置选区顶点
 
 ```java
-ivCrop.setImageBitmap(selectedBitmap);
 ivCrop.setCropPoints(points);    
 ```
-将选区顶点，需要显示的图片设置给 CropImageView 显示图片，绘制选区。 先设置图片再设置选区顶点。如果设置的顶点无效会默认使用包裹整个图片的顶点。
 
-### 3. 裁剪：
+将上一个步骤返回的选区顶点，设置给 CropImageView 绘制选区。   
+
+注意：必须先设置图片（setImageBitmap(selectedBitmap)）再设置选区顶点，否则选区将失效。如果设置的顶点无效会默认使用包裹整个图片的选区。
+
+### 3. 裁剪选区内的图片：
 
 ```java  
 Bitmap crop = ivCrop.crop();  
 ```  
-根据选区裁剪出选区内的图片，并使用透视变换矫正。
+根据选区裁剪出选区内的图片，并使用透视变换矫正成正面图片。  
+
+注意：与 SmartCropper.scan 类似，改方法主要逻辑也是位于 native 层，运行时间与图片大小成正比，在大图片的情况下，可以考虑在子线程执行，或者压缩传入的图片。
 
 ## API 说明
 
 ### SmartCropper 类：
 
-#### 1. 扫描边框，大图下会比较耗时，注意在子线程操作
+对外提供统一的图片处理接口，其主要实现位于 native 层。  
+
+#### 1. 扫描边框，大图下会比较耗时，考虑子线程调用。
 
 ```java
 public static Point[] scan(Bitmap srcBmp)
-``` 
-返回值为大小为4的 Point 数组，表示选区边框的四个顶点，依次为左上，右上，右下，左下。
+```   
+
+返回值是大小为4的 Point 数组，表示选区边框的四个顶点，依次为左上，右上，右下，左下。
 
-#### 2. 根据边框顶点裁剪，大图下会比较耗时，注意在子线程操作
+#### 2. 根据边框顶点裁剪，大图下会比较耗时，考虑子线程调用。
 
 ```java
 public static Bitmap crop(Bitmap srcBmp, Point[] cropPoints)
 ```
 
 ### CropImageView 类：
 
-#### 1. 设置裁剪边框锚点,必须先设置图片
+继承于 ImageView，用于显示选区，辅助线，放大镜等
+
+#### 1. 设置裁剪边框锚点,必须先设置图片，否者该方法会失效
 ```java
 public void setCropPoints(Point[] cropPoints)  
 ```  
-cropPoints 的大小必须为4，依次为左上，右上，右下，左下，**顶点的坐标是基于设置图片的大小，而非 View 的大小**。
+cropPoints 的大小必须为4，依次为左上，右上，右下，左下。SmartCropper.scan 返回的数组已经排过序。
+
+注意：顶点的坐标是基于设置图片的大小，而非 View 的大小
 
 #### 2. 设置选区外的透明度
 ```java
@@ -138,18 +159,25 @@ public void setFullImgCrop()
 ```  
 
 
-## TODOS
+## Features
 
-1. 优化智能选区算法
-2. ~~优化点排序算法~~
-3. ~~CropImageView 选区放大镜效果~~
-4. CropImageView xml属性配置
-5. ...
+- [x] 优化点排序算法
+- [x] CropImageView 选区放大镜效果
+- [ ] 优化智能选区算法
+- [ ] CropImageView xml属性配置
+- [ ] 欢迎提 ISSUE
 
 ---
-如有问题可联系：pqponet#gmail.com, 也可提 ISSUE。  
-我的博客：https://pqpo.me  
 
+## 关于我：
+
+- 邮箱：    [email protected]
+- GitHub：  [pqpo](https://github.com/pqpo)
+- 博客：    [pqpo's notes](https://pqpo.me)
+- Twitter: [Pqponet](https://twitter.com/Pqponet)
+- 微信公众号: pqpo_me(扫下方二维码) 
+
+<img src="art/qrcode_for_gh.jpg" width="200">
 
 License
 -------

README_EN.md

@@ -0,0 +1,116 @@
+# SmartCropper
+
+## English | [中文](README.md)
+
+A library for cropping image in a smart way that can identify the border and correct the cropped image. Applicable to ID cards, business cards, documents and other photos of the crop. If you like, welcome start, fork or follow me.
+
+
+## Features
+
+- Crop image in a smart way that can identify the border.
+- Support drag anchors, magnifying glass effect to enhance the positioning experience.
+- Use the perspective transform to crop and correct the selection to restore the front image.
+- Support rich UI settings, such as auxiliary lines, mask, anchor, magnifying glass and so on.
+
+## Sample（[link](art/SmartCropperSampleV5.apk)）
+
+### 1. Select a image, use the perspective transform to crop and correct the selection:
+
+![](art/smart_crop_1.png)
+![](art/cropped_1.png)
+
+### 2. drag anchors, magnifying glass effect to enhance the positioning experience:
+
+![](art/advance_crop_1.png)
+
+### gif：
+
+![](art/smartcropper_photo.gif)
+![](art/smartcropper_album.gif)
+
+## Import
+
+You can clone the project,and import smartcropperlib as a Android moudle to your project. Or import aar files.（JCenter address will be provided later）
+
+note：
+
+```
+-keep class me.pqpo.smartcropperlib.**{*;}
+```  
+
+## Usage  
+
+### 1. Use CropImageView in your xml file.  
+```xml
+<me.pqpo.smartcropperlib.view.CropImageView   
+        android:id="@+id/iv_crop"  
+        android:layout_width="match_parent" 
+        android:layout_height="match_parent" />  
+```  
+
+note： CropImageView extends from ImageView，and ScaleType must be center type，If you set ScaleType to fit_end,fit_start,matrix will throws an error。  
+
+### 2. Intelligent constituency：    
+
+```java  
+Point[] points = SmartCropper.scan(selectedBitmap);    
+```  
+
+It will identify the border by native(c/c++), and the returned points are arrays of size 4, it's the four vertices of the selection border, sorted by the top left, top right, bottom right, bottom left.     
+
+### 3. Set the selection vertices:
+
+```java
+ivCrop.setCropPoints(points);    
+```
+
+Returns the selection vertices of the previous step to the CropImageView drawing selection.  
+
+note：You should call after set image to ImageView(setImageBitmap(selectedBitmap))
+
+### 3. Crop the image：
+
+```java  
+Bitmap crop = ivCrop.crop();  
+```  
+
+## Features
+
+- [x] Optimization point sorting algorithm
+- [x] CropImageView selection magnifying effect
+- [ ] Optimization of intelligent selection algorithm
+- [ ] CropImageView xml settings
+- [ ] Please submit ISSUEs
+
+---
+
+## Author：
+
+- Email：    [email protected]
+- GitHub：  [pqpo](https://github.com/pqpo)
+- Blog：    [pqpo's notes](https://pqpo.me)
+- Twitter: [Pqponet](https://twitter.com/Pqponet)
+- WeChat: pqpo_me
+
+<img src="art/qrcode_for_gh.jpg" width="200">
+
+License
+-------
+
+    Copyright 2017 pqpo
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+
+
+