Skip to content

Commit 471f797

Browse files
committed
Update Docs & Readme
1 parent afd3b41 commit 471f797

File tree

4 files changed

+12
-4
lines changed

4 files changed

+12
-4
lines changed

Example/Controllers/ViewController.swift

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,5 +84,3 @@ extension ViewController {
8484
return "You can pass your image or animatable view. See Readme for more details."
8585
}
8686
}
87-
88-

Readme.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,8 @@ For now supporting `Done`, `Heart`, `Doc`, `Error` & `Message` presets.
8181
<img src="https://github.com/ivanvorobei/SPAlert/blob/master/Assets/Readme/Miniature%20-%20Error.svg" width="80">
8282
</p>
8383

84+
Also I can propose extra pack with 15 presets for all my donators. You can become [here](https://www.patreon.com/ivanvorobei).
85+
8486
## Quick Start
8587

8688
For best experience, I recommend call alerts by `SPAlert`. These functions are updated regularly and show as Apple way. I focus on presets:

Source/SPAlert/Models/SPAlertLayout.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ public struct SPAlertLayout {
3737
public var bottomSpace: CGFloat = 25
3838

3939
/**
40-
Icon width.
40+
Icon view width.
4141
*/
4242
public var iconWidth: CGFloat = 100
4343

4444
/**
45-
Icon height.
45+
Icon view height.
4646
*/
4747
public var iconHeight: CGFloat = 100
4848

Source/SPAlert/SPAlert.swift

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@ public enum SPAlert {
2828

2929
/**
3030
Present with presets.
31+
32+
- parameter title: Main text in alert.
33+
- parameter message: Subtitle in alert. Optional.
34+
- parameter preset: Default configure layout and icons.
3135
*/
3236
public static func present(title: String, message: String? = nil, preset: SPAlertPreset) {
3337
let alertView = SPAlertView(title: title, message: message, preset: preset)
@@ -36,6 +40,10 @@ public enum SPAlert {
3640

3741
/**
3842
Present with image.
43+
44+
- parameter title: Main text in alert.
45+
- parameter message: Subtitle in alert. Optional.
46+
- parameter image: Custom `UIImage` for alert.
3947
*/
4048
public static func present(title: String, message: String? = nil, image: UIImage) {
4149
let alertView = SPAlertView(title: title, message: message, image: image)

0 commit comments

Comments
 (0)