📝 update doc.

JingYeoh · Aug 2, 2018 · b9ef6d8 · b9ef6d8
1 parent 2ac5f70
commit b9ef6d8
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 2 deletions.
diff --git a/README-CN.md b/README-CN.md
@@ -41,6 +41,7 @@
 * [转场动画](https://github.com/JustKiddingBaby/FragmentRigger/wiki/转场动画)
 * [onBackPressed拦截](https://github.com/JustKiddingBaby/FragmentRigger/wiki/onBackPressed拦截)
 * [startFragmentForResult方法](https://github.com/JustKiddingBaby/FragmentRigger/wiki/startFragmentForResult方法)
+* 滑动退出Activity/Fragment
 * [如何在library module中使用](https://github.com/JustKiddingBaby/FragmentRigger/wiki/如何在library-module中使用)
 #### 信息
 * [gradle错误](https://github.com/JustKiddingBaby/FragmentRigger/wiki/gradle%E4%BE%9D%E8%B5%96%E9%97%AE%E9%A2%98)
@@ -59,9 +60,9 @@
 - [x] **Fragment转场动画**
 - [x] **自定义Fragment tag**
 - [x] **为非栈内的Fragment添加onBackPressed支持**
+- [x] **滑动边缘退出Activity/Fragment**
 - [ ] **配置Fragment启动模式的选项**
 - [ ] **Fragment间共享元素转场动画**
-- [ ] **左滑退出**
 - [ ] **支持DialogFragment**
 
 ### 解决的问题
@@ -108,6 +109,25 @@ public class MainActivity extends AppCompatActivity{
 }
 ```
 
+
+**3、Activity/Fragment 滑动退出**
+>在需要滑动边缘退出的`Activity/Fragment`上添加`Swiper`注解.
+
+```java
+@Swiper
+@Puppet
+public class MainActivity extends AppCompatActivity{
+    // swiper 只可以使用在有 puppet 注解的类上.
+}
+```
+```java
+@Swiper
+@Puppet
+public class TestFragment extends Fragment{
+   // swiper 只可以使用在有 puppet 注解的类上.
+}
+```
+
 ### License
 ![](https://upload.wikimedia.org/wikipedia/commons/thumb/f/f8/License_icon-mit-88x31-2.svg/128px-License_icon-mit-88x31-2.svg.png)
 

diff --git a/README.md b/README.md
@@ -42,6 +42,7 @@ You can use this `FragmentRigger` with one line annotation.
 * [Transition animations](https://github.com/JustKiddingBaby/FragmentRigger/wiki/Transition-animations)
 * [Intercept onBackPressed](https://github.com/JustKiddingBaby/FragmentRigger/wiki/Intercept-onBackPressed)
 * [startFragmentForResult](https://github.com/JustKiddingBaby/FragmentRigger/wiki/startFragmentForResult)
+* Swipe edge to exit Activity/Fragment
 * [How to use in library module](https://github.com/JustKiddingBaby/FragmentRigger/wiki/How-to-use-in-library-module)
 #### Information
 * [Errors in gradle](https://github.com/JustKiddingBaby/FragmentRigger/wiki/Errors-in-gradle)
@@ -60,9 +61,9 @@ You can use this `FragmentRigger` with one line annotation.
 - [x] **Fragment transition animations**
 - [x] **Option to configure fragment tag**
 - [x] **Add `onBackPressed` method support for the fragment that is not added into stack**
+- [x] **Swipe edge to exit Fragment/Activity**
 - [ ] **Option to configure fragment launch mode**
 - [ ] **Fragment shared elements transition animations**
-- [ ] **Swipe edge to exit Fragment/Activity**
 - [ ] **Support DialogFragment**
 
 ### Problem solved
@@ -107,6 +108,24 @@ public class MainActivity extends AppCompatActivity{
 }
 ```
 
+**3、Activity/Fragment swipe back to exit**
+>Add `Swiper` annotation for your `Activity/Fragment`.
+
+```java
+@Swiper
+@Puppet
+public class MainActivity extends AppCompatActivity{
+    // swiper can only used with puppet.
+}
+```
+```java
+@Swiper
+@Puppet
+public class TestFragment extends Fragment{
+    // swiper can only used with puppet.
+}
+```
+
 ### License
 ![](https://upload.wikimedia.org/wikipedia/commons/thumb/f/f8/License_icon-mit-88x31-2.svg/128px-License_icon-mit-88x31-2.svg.png)