Skip to content

Commit 0b94026

Browse files
committed
Update README.
1 parent 94d4502 commit 0b94026

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

README.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,24 @@
22

33
[ChinaMobilePhoneNumberRegex] wrappers for iOS and macOS in Swift.
44

5-
## Usage
5+
## Features
6+
- Pure-Swift interface
7+
- Well-documented
8+
- Extensively tested
69

7-
```swift
8-
let regex = VSRegex() // Match all numbers by default.
9-
let isMatch = regex.matches("+8613800138000")
10-
print(isMatch) // true
10+
## Requirements
1111

12+
- iOS 8.0+ / macOS X 10.9+ / tvOS 9.0+ / watchOS 2.0+
13+
- Xcode 9.0+
14+
- Swift 4.0+
1215

13-
let regex = VSRegex(.carrier(.chinaTelecom))
14-
let isMatch = regex.matches("+8613800138000")
15-
print(isMatch) // false
16+
## Quick Start
1617

17-
18-
let isMatch = VSRegex.matches("+8613800138000")
19-
print(isMatch) // true
18+
```swift
19+
import VSRegex
2020

21-
22-
let isMatch = VSRegex.is("+8613800138000", matches: .carrier(.chinaMobile))
21+
let isMatch = VSRegex.matches("+8613800138000")
2322
print(isMatch) // true
24-
25-
...
2623
```
2724

2825
## Installation

0 commit comments

Comments
 (0)