Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tattn authored Dec 24, 2017
1 parent 1c9658c commit 6448310
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,20 @@ SwipeTransition

SwipeTransition allows trendy transitions using swipe gesture such as "swipe back".

<img src="https://github.com/tattn/SwipeTransition/raw/master/docs/assets/demo.gif" alt="Demo" width="50%" />

# Usage

## The easiest way to use

Just setting these frameworks in the Embedded Binaries will work.
Just setting these frameworks in the Embedded Binaries, it works.

![Embedded Binaries](https://github.com/tattn/SwipeTransition/raw/master/docs/assets/embedded_binaries.png)

Notes: these frameworks use Method Swizzling.

When setting manually, please use `SwipeTransition.framework`.

## Swipe back

Just use `BackSwipeableNavigationController` instead of `UINavigationController`. Of course, you can set it with Interface Builder.
Expand All @@ -34,6 +40,10 @@ class CustomNavigationController: UINavigationController, BackSwipeable {
}
```

Notes: it's unavailable using `Auto*.framework`.

### Configuration

It is possible to disable the feature only for a specific view controller.

```swift
Expand Down Expand Up @@ -71,6 +81,10 @@ class CustomNavigationController: UINavigationController, SwipeableToDismiss {
}
```

Notes: it's unavailable using `Auto*.framework`.

### Configuration

It is possible to disable the feature only for a specific view controller.

```swift
Expand Down Expand Up @@ -104,7 +118,7 @@ class ScrollVC: UIViewController, UIScrollViewDelegate {
}
```

## Configuration
## Common Configuration

You can also change the behavior such as animation.

Expand Down

0 comments on commit 6448310

Please sign in to comment.