Skip to content

Commit 9f7cda5

Browse files
authored
Merge pull request hackiftekhar#1072 from ealeksandrov/master
Cleanup README
2 parents 4e18a5c + 6bc5a8e commit 9f7cda5

File tree

1 file changed

+38
-42
lines changed

1 file changed

+38
-42
lines changed

README.md

+38-42
Original file line numberDiff line numberDiff line change
@@ -55,24 +55,29 @@ alt="IQKeyboardManager Demo Video" width="480" height="360" border="10" /></a>
5555
## Requirements
5656
[![Platform iOS](https://img.shields.io/badge/Platform-iOS-blue.svg?style=fla)]()
5757

58-
#### IQKeyboardManager:-
59-
[![Objective-c](https://img.shields.io/badge/Language-Objective C-blue.svg?style=flat)](https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/ProgrammingWithObjectiveC/Introduction/Introduction.html)
58+
| | Language | Minimum iOS Target | Minimum Xcode Version |
59+
|------------------------|----------|--------------------|-----------------------|
60+
| IQKeyboardManager | Obj-C | iOS 8.0 | Xcode 8.2.1 |
61+
| IQKeyboardManagerSwift | Swift | iOS 8.0 | Xcode 8.2.1 |
62+
| Demo Project | | | Xcode 9.0 |
6063

61-
Minimum iOS Target: iOS 8.0
62-
63-
Minimum Xcode Version: Xcode 8.2.1
64-
65-
#### IQKeyboardManagerSwift:-
66-
[![Swift 3.1 compatible](https://img.shields.io/badge/Language-Swift3-blue.svg?style=flat)](https://developer.apple.com/swift)
67-
68-
Minimum iOS Target: iOS 8.0
69-
70-
Minimum Xcode Version: Xcode 8.2.1
64+
**Note**
65+
- 3.3.7 is the last iOS 7 supported version.
7166

72-
#### Demo Project:-
67+
#### Swift versions support
7368

74-
Minimum Xcode Version: Xcode 9.0
69+
| Swift | Xcode | IQKeyboardManagerSwift |
70+
|-------------|-------|------------------------|
71+
| 4.X | 9.0 | >= 5.0.0 |
72+
| 4.0 | 9.0 | 5.0.0 |
73+
| 3.1 | 8.3 | 4.0.10 |
74+
| 3.0 (3.0.2) | 8.2 | 4.0.8 |
75+
| 2.2 or 2.3 | 7.3 | 4.0.5 |
76+
| 2.1.1 | 7.2 | 4.0.0 |
77+
| 2.0 | 7.0 | 3.3.3.1 |
7578

79+
**Note**
80+
- `5.0.0` is backward compatible till Swift 3.
7681

7782
Installation
7883
==========================
@@ -81,38 +86,29 @@ Installation
8186

8287
[![CocoaPods](https://img.shields.io/cocoapods/v/IQKeyboardManager.svg)](http://cocoadocs.org/docsets/IQKeyboardManager)
8388

84-
**Note:-**
85-
- 3.3.7 is the last iOS 7 supported version.
86-
87-
***IQKeyboardManager (Objective-C):-*** IQKeyboardManager is available through [CocoaPods](http://cocoapods.org), to install
89+
***IQKeyboardManager (Objective-C):*** IQKeyboardManager is available through [CocoaPods](http://cocoapods.org), to install
8890
it simply add the following line to your Podfile: ([#9](https://github.com/hackiftekhar/IQKeyboardManager/issues/9))
8991

90-
*iOS8 and later* `pod 'IQKeyboardManager'`
92+
```ruby
93+
`pod 'IQKeyboardManager'` #iOS8 and later
9194

92-
*iOS7* `pod 'IQKeyboardManagerSwift', '3.3.7'`
95+
`pod 'IQKeyboardManager', '3.3.7'` #iOS7
96+
```
9397

94-
***IQKeyboardManager (Swift):-*** IQKeyboardManagerSwift is available through [CocoaPods](http://cocoapods.org), to install
98+
***IQKeyboardManager (Swift):*** IQKeyboardManagerSwift is available through [CocoaPods](http://cocoapods.org), to install
9599
it simply add the following line to your Podfile: ([#236](https://github.com/hackiftekhar/IQKeyboardManager/issues/236))
96100

97101
*Swift 4.0 (Xcode 9.0)*
98102

99-
`pod 'IQKeyboardManagerSwift'`
100-
101-
*Or*
102-
103-
`pod 'IQKeyboardManagerSwift', '5.0.0'` #`It's backward compatible till Swift3`
104-
105-
*Swift 4.0 (Xcode 9.0)* `pod 'IQKeyboardManagerSwift', '5.0.0'`
106-
107-
*Swift 3.1 (Xcode 8.3)* `pod 'IQKeyboardManagerSwift', '4.0.10'`
108-
109-
*Swift 3.0(3.0.2) (Xcode 8.2)* `pod 'IQKeyboardManagerSwift', '4.0.8'`
110-
111-
*Swift 2.2 or 2.3 (Xcode 7.3)* `pod 'IQKeyboardManagerSwift', '4.0.5'`
103+
```ruby
104+
pod 'IQKeyboardManagerSwift'
105+
```
112106

113-
*Swift 2.1.1 (Xcode 7.2)* `pod 'IQKeyboardManagerSwift', '4.0.0'`
107+
*Or you can choose version you need based on Swift support table from [Requirements](README.md#requirements)*
114108

115-
*Swift 2.0 (Xcode 7.0)* `pod 'IQKeyboardManagerSwift', '3.3.3.1'`
109+
```ruby
110+
pod 'IQKeyboardManagerSwift', '5.0.0'
111+
```
116112

117113
In AppDelegate.swift, just import IQKeyboardManagerSwift framework and enable IQKeyboardManager.
118114

@@ -153,15 +149,15 @@ github "hackiftekhar/IQKeyboardManager"
153149
Run `carthage` to build the frameworks and drag the appropriate framework (`IQKeyboardManager.framework` or `IQKeyboardManagerSwift.framework`) into your Xcode project according to your need. Make sure to add only one framework and not both.
154150

155151

156-
#### Installation with Source Code:-
152+
#### Installation with Source Code
157153

158154
[![Github tag](https://img.shields.io/github/tag/hackiftekhar/iqkeyboardmanager.svg)]()
159155

160156

161157

162-
***IQKeyboardManager (Objective-C):-*** Just ***drag and drop*** `IQKeyboardManager` directory from demo project to your project. That's it.
158+
***IQKeyboardManager (Objective-C):*** Just ***drag and drop*** `IQKeyboardManager` directory from demo project to your project. That's it.
163159

164-
***IQKeyboardManager (Swift):-*** ***Drag and drop*** `IQKeyboardManagerSwift` directory from demo project to your project
160+
***IQKeyboardManager (Swift):*** ***Drag and drop*** `IQKeyboardManagerSwift` directory from demo project to your project
165161

166162
In AppDelegate.swift, just enable IQKeyboardManager.
167163

@@ -181,11 +177,11 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
181177
```
182178

183179

184-
## Known Issues:-
180+
## Known Issues
185181

186182
You can find known issues list [here](https://github.com/hackiftekhar/IQKeyboardManager/blob/master/KNOWN%20ISSUES.md).
187183

188-
Manual Management:-
184+
Manual Management:
189185
---
190186

191187
You can find some manual management tweaks & examples [here](https://github.com/hackiftekhar/IQKeyboardManager/blob/master/MANUAL%20MANAGEMENT.md).
@@ -199,7 +195,7 @@ If you would like to see detailed Flow diagram then see [here](https://raw.githu
199195

200196

201197

202-
## Properties and functions usage:-
198+
## Properties and functions usage
203199

204200
You can find some documentation about properties, methods and their uses [here](https://github.com/hackiftekhar/IQKeyboardManager/blob/master/PROPERTIES%20%26%20FUNCTIONS.md).
205201

0 commit comments

Comments
 (0)