Skip to content

Commit 16b1022

Browse files
authored
Merge pull request #19 from JillevdW/patch-1
fixes mistakes in the Readme.md file
2 parents 32c7d8a + 50108c5 commit 16b1022

File tree

1 file changed

+21
-22
lines changed

1 file changed

+21
-22
lines changed

Readme.md

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# SPAlert
22

3-
**Popup from Apple Music & Feedback in AppStore**. Contains `Done`, `Heart`, `Error` and other presets. Support Dark Mode. I clone Apple's alerts as much as possible. You can find this alerts in AppStore after feedback and after added song to library in Apple Music.
3+
**Popup from Apple Music & Feedback in AppStore**. Contains `Done`, `Heart`, `Error` and other presets. Supports Dark Mode. I tried to recreate Apple's alerts as much as possible. You can find these alerts in the AppStore after feedback and after you add a song to your library in Apple Music.
44

55
<p float="left">
66
<img src="https://github.com/ivanvorobei/SPAlert/blob/master/Assets/Readme/Preview%20-%20Done.gif" width="230">
77
<img src="https://github.com/ivanvorobei/SPAlert/blob/master/Assets/Readme/Preview%20-%20Heart.gif" width="230">
88
<img src="https://github.com/ivanvorobei/SPAlert/blob/master/Assets/Readme/Preview%20-%20Message.gif" width="230">
99
</p>
1010

11-
And other
11+
And more:
1212

1313
<p float="left">
1414
<img src="https://github.com/ivanvorobei/SPAlert/blob/master/Assets/Readme/Miniature%20-%20Doc.svg" width="50">
@@ -34,9 +34,9 @@ And other
3434
<img src="https://github.com/ivanvorobei/SPAlert/blob/master/Assets/Readme/Miniature%20-%20Repeat.svg" width="50">
3535
</p>
3636

37-
If you like the project, do not forget to `put star ★` and follow me on GitHub. To help project, see [Сooperation](#сooperation) section.
37+
If you like the project, please do not forget to `star ★` this repository and follow me on GitHub. To help out with the project, see the [Сooperation](#сooperation) section.
3838

39-
Check example usage in app _Debts - Spending tracker_ for [iOS](https://itunes.apple.com/app/id1446635818) and [macOS](https://apps.apple.com/app/id1496914334). You can buy source code this apps in my store for iOS developers:
39+
For an example of this plugin in use, check this app: _Debts - Spending tracker_ for [iOS](https://itunes.apple.com/app/id1446635818) and [macOS](https://apps.apple.com/app/id1496914334). You can buy source code this apps in my store for iOS developers:
4040

4141
[![xcode-shop.com](https://github.com/ivanvorobei/SPPermissions/blob/master/Assets/Buttons/xcode-shop.svg)](https://xcode-shop.com)
4242
[![https://github.com/ivanvorobei](https://github.com/ivanvorobei/SPPermissions/blob/master/Assets/Buttons/follow-me-on-github.svg)](https://github.com/ivanvorobei)
@@ -98,31 +98,31 @@ If you prefer not to use any of dependency managers, you can integrate `SPAlert`
9898

9999
## Quick Start
100100

101-
For best experience, I recommend call alerts by `SPAlert`. These functions are updated regularly and show as Apple way. I focus on presets:
101+
For best experience, I recommend presenting the alerts by calling the class functions on `SPAlert`. These functions are updated regularly and show the alerts "the Apple way". I focus on presets:
102102

103103
```swift
104104
SPAlert.present(title: "Added to Library", preset: .done)
105105
```
106106

107-
If you want use custom image, use func:
107+
For using a custom image:
108108

109109
```swift
110110
SPAlert.present(title: "Love", message: "We'll recommend more like this in For You", image: UIImage(named: "Heart")!)
111111
```
112112

113-
For show simple text message, use:
113+
For showing a simple text message:
114114

115115
```swift
116-
SPAlert.present(message: "Empty UITextField")
116+
SPAlert.present(message: "Text!")
117117
```
118118

119119
## Usage
120120

121-
Sometimes it may require deep customization. In this section, I will show you what you can do.
121+
If you require deep customization, this section will show you what you can do.
122122

123123
### Duration
124124

125-
To change the time that the `SPAlert` will be shown, use property `duration`:
125+
If you want the `SPAlert` to be shwon longer, use the `duration` property:
126126

127127
```swift
128128
let alertView = SPAlertView(title: "Added to Library", message: nil, preset: SPAlertPreset.done)
@@ -134,61 +134,60 @@ alertView.present()
134134

135135
<img align="left" src="https://github.com/ivanvorobei/SPAlert/blob/master/Assets/Readme/Preview%20-%20DarkMode.jpg" width="220">
136136

137-
Dark Mode no need additional configuration. As soon as the user change the interface to dark, all alerts will appear dark.
137+
Dark Mode needs no additional configuration. As soon as the user changes their interface to dark, all alerts will follow suit.
138138

139-
For check state of user appearance I am use `traitCollection`:
139+
This is achieved by checking the `userInterfaceStyle` property on `traitCollection`.:
140140

141141
```swift
142142
if self.traitCollection.userInterfaceStyle == .dark {
143143
return true
144144
}
145145
```
146146

147-
It available since iOS 12, for early using always Light Mode.
147+
It is available since iOS 12, for earlier iOS versions the alerts will always be shown in Light Mode.
148148

149149
### Layout
150150

151-
Here you can change the sizes and spaces:
151+
To change the size and spacing of the alerts:
152152

153153
```swift
154154
alertView.layout.topSpace = 18
155155
alertView.layout.iconHeight = 25
156156
```
157157

158-
For more properties see class.
158+
For more properties see the class.
159159

160160
### Dismiss by Tap
161161

162-
If you click on the alert, it will disappear ahead of time. This can be disabled:
162+
If you tap the alert, it will disappear ahead of time. This can be disabled:
163163

164164
```swift
165165
alertView.dismissByTap = false
166166
```
167167

168168
### Haptic
169169

170-
If you use presets, the vibro-response will be start automatically. For customize this, you need set property `haptic`:
170+
If you use presets, the vibro-response will be started automatically. To customize this, you need set the `haptic` property:
171171

172172
```swift
173173
alertView.haptic = .success
174174
```
175175

176-
For disable haptic, set it to `.none`.
176+
To disable haptics, set it to `.none`.
177177

178178
### Corner Radius
179179

180-
I use a corner radius like an Apple. If you need to change it, see the property `cornerRadius`:
180+
You can change the corner radius by setting the `cornerRadius` property:
181181

182182
```swift
183183
alertView.layer.cornerRadius = 40
184184
```
185185

186186
## Сooperation
187187

188-
The development of this project is completely free. If you can make a contribution, it will help development. Here list of task what need do:
188+
This project is free to use, but developing it takes time. Contributing to this project is a huge help. Here is list of tasks that need to be done:
189189

190-
- Fix mistakes in this Readme and docs. My English so bad. Good create pull request.
191-
- Add docs in source files. Description of public methods and parametrs.
190+
- Add documentation in the source files (description of public methods and parameters).
192191
- Help me translate my app [Debts - Spending tracker](https://itunes.apple.com/app/id1446635818) for other languages.
193192

194193
## License

0 commit comments

Comments
 (0)