Skip to content

Commit

Permalink
Update podspec and README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
hitsubunnu committed Nov 7, 2019
1 parent dce09bb commit 9f5587d
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 10 deletions.
6 changes: 3 additions & 3 deletions QRScanner.podspec → MercariQRScanner.podspec
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# QRScanner.podspec
# MercariQRScanner.podspec

Pod::Spec.new do |s|
s.name = "QRScanner"
s.name = "MercariQRScanner"
s.version = "1.0"
s.summary = "A QR Code scanner framework for iOS. Written in Swift."
s.summary = "A simple QR Code scanner framework for iOS. Provides a similar scan effect to ios13+. Written in Swift."
s.homepage = "https://github.com/mercari/QRScanner"
s.license = "MIT"
s.author = { "hitsubunnu" => "[email protected]" }
Expand Down
29 changes: 22 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# QRScanner
A QR Code scanner framework for iOS. Written in Swift.
A simple QR Code scanner framework for iOS. Provides a similar scan effect to ios13+. Written in Swift.

|iOS 13.0+|QRScanner iOS 10.0+|
|-|-|
|<img src="./images/ios13qr.gif" width="350">|<img src="./images/qr.gif" width="350">|
|<img src="https://raw.githubusercontent.com/mercari/QRScanner/master/images/ios13qr.gif" width="350">|<img src="https://raw.githubusercontent.com/mercari/QRScanner/master/images/qr.gif" width="350">|

"QR Code" is a registered trademark of DENSO WAVE INCORPORATED

## Feature
- Similar to iOS 13.0+ design
- Simple usage <a href="https://github.com/kouzoh/QRScanner/blob/master/QRScannerSample/QRScannerSample/ViewController.swift" target="_blank">Sample</a>
- Simple usage <a href="https://github.com/mercari/QRScanner/blob/master/QRScannerSample/QRScannerSample/ViewController.swift" target="_blank">Sample</a>
- Support for iOS 10.0+

## Development Requirements
Expand All @@ -22,10 +22,20 @@ A QR Code scanner framework for iOS. Written in Swift.

### The Pod Way

Simply add the following line to your <code>Podfile</code>:
- Simply add the following line to your <code>Podfile</code>
```
platform :ios, '10.0'
pod 'MercariQRScanner'
```

platform :ios, '10.0'
pod 'QRScanner'
- Run command
```
pod install
```
- Write Import statement on your source file
```
Import MercariQRScanner
```

### The Carthage Way

Expand Down Expand Up @@ -59,11 +69,16 @@ Import QRScanner

## Usage

### See [QRScannerSample](https://github.com/kouzoh/QRScanner/tree/master/QRScannerSample)
See [QRScannerSample](https://github.com/mercari/QRScanner/tree/master/QRScannerSample)

### Add `Privacy - Camera Usage Description` to Info.plist file

<img src="https://raw.githubusercontent.com/mercari/QRScanner/master/images/privacy_camera.png" width="500">

### Source Code

```
// If use the Pod way, import MercariQRScanner
import QRScanner
final class ViewController: UIViewController {
Expand Down
Binary file added images/privacy_camera.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9f5587d

Please sign in to comment.