Skip to content

Commit

Permalink
docs: update CHANGELOG and guideline for integration
Browse files Browse the repository at this point in the history
  • Loading branch information
lengocduy committed Nov 1, 2021
1 parent e13d1b5 commit 7622822
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 2 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Changelog

## [v1.0.0](https://github.com/lengocduy/DLSwipeToPopController/tree/v1.0.0) (2021-10-31)

- Swipe from Right to Left to pop ViewController
- Customize via `velocity` when swipe gesture was recognized
- Drag from Right to Left to pop ViewController
- Customize via `percent` distance move per screen's width
- Built-in Controllers: `SwipeToPopViewController` & `SwipeToPopTableViewController`
2 changes: 1 addition & 1 deletion DLSwipeToPopController.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Pod::Spec.new do |s|
s.homepage = 'https://github.com/lengocduy/DLSwipeToPopController'
s.license = { :type => 'MIT', :file => 'LICENSE.md' }
s.author = { "Le Ngoc Duy" => "askbills@gmail.com" }
s.source = { :git => 'https://github.com/lengocduy/DLSwipeToPopController.git', :tag => s.version.to_s }
s.source = { :git => 'https://github.com/lengocduy/DLSwipeToPopController.git', :tag => "v#{s.version}" }

s.ios.deployment_target = '11.0'

Expand Down
47 changes: 46 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,54 @@ Reusable iOS's behavior to pop ViewController base on [SwipeRightToPopController
- Xcode 11+
- Swift 5.0+

## Installing

There are three ways to install `DLSwipeToPopController`

### 1. CocoaPods

Just add to your project's `Podfile`:

```
pod 'DLSwipeToPopController', '~> 1.0'
```

### 2. Carthage

Add following to `Cartfile`:

```
github "lengocduy/DLSwipeToPopController" ~> 1.0
```

### 3. Swift Package Manager

Create a `Package.swift` file:

```
// swift-tools-version:5.0
import PackageDescription
let package = Package(
name: "TestSwipeToPopController",
dependencies: [
.package(url: "https://github.com/lengocduy/DLSwipeToPopController.git", from: "1.0.0"),
],
targets: [
.target(
name: "TestSwipeToPopController",
dependencies: ["DLSwipeToPopController"])
]
)
```

## Architecture

![Architecture](/ArchDiagram.png)
![Architecture](https://github.com/lengocduy/DLSwipeToPopController/blob/v1.0.0/ArchDiagram.png?raw=true)

## License

Expand Down

0 comments on commit 7622822

Please sign in to comment.