Skip to content

Commit 215cf2c

Browse files
committed
Update README
1 parent da57a76 commit 215cf2c

File tree

1 file changed

+26
-25
lines changed

1 file changed

+26
-25
lines changed

README.md

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ For first-hand experience, just open the project and run it.
3535

3636
### Cocoapods
3737

38-
Install Cocoapods if need be.
38+
Install [Cocoapods](https://cocoapods.org/#install) if need be.
3939

4040
```bash
4141
$ gem install cocoapods
@@ -49,14 +49,25 @@ use_frameworks!
4949
pod 'NVActivityIndicatorView'
5050
```
5151

52+
If you're using `NVActivityIndicatorView` in an app extension, use `NVActivityIndicatorView/AppExtension` instead.
53+
54+
```ruby
55+
use_frameworks!
56+
57+
pod 'NVActivityIndicatorView/AppExtension'
58+
```
59+
5260
Then, run the following command.
5361

5462
```bash
5563
$ pod install
5664
```
65+
66+
_**Note:** Please refer to the migration note for version [`3.7.0`](#version-370) below._
67+
5768
### Carthage
5869

59-
Install Carthage if need be.
70+
Install [Carthage](https://github.com/Carthage/Carthage#installing-carthage) if need be.
6071

6172
```bash
6273
$ brew update
@@ -69,7 +80,7 @@ Add `NVActivityIndicatorView` in your `Cartfile`.
6980
github "ninjaprox/NVActivityIndicatorView"
7081
```
7182

72-
Run `carthage` to build the framework and drag the built `NVActivityIndicatorView.framework` into your Xcode project.
83+
Run `carthage` to build the framework and drag the built `NVActivityIndicatorView_iOS.framework`, `NVActivityIndicatorViewAppExtension_iOS.framework` or `NVActivityIndicatorView_tvOS.framework` into your Xcode project.
7384

7485
_**Note:** You might encounter compile issue, if so please use `carthage` branch instead. Check issue [#101](https://github.com/ninjaprox/NVActivityIndicatorView/issues/101) for more information._
7586

@@ -83,6 +94,10 @@ _**Note:** If you encounter issues while uploading the app to iTunes Connect, re
8394

8495
## Migration
8596

97+
### Version 4.4.0
98+
99+
This version requires Xcode 10.1 and Swift 4.2.
100+
86101
### Version 4.0.0
87102

88103
This version requires Xcode 9.0 and Swift 4.
@@ -91,41 +106,27 @@ This version requires Xcode 9.0 and Swift 4.
91106

92107
This version splits `NVActivityIndicatorView` pod to 2 subpods `NVActivityIndicatorView/Presenter` and `NVActivityIndicatorView/AppExtension`. There is no need to change `pod NVActivityIndicatorView` to `pod NVActivityIndicatorView/Presenter` since it will be installed by default if you use the main pod name.
93108

94-
However, if you want to use `NVActivityIndicatorView` in app extension, use `pod NVActivityIndicatorView/AppExtension` instead.
109+
However, if you want to use `NVActivityIndicatorView` in an app extension, use `pod NVActivityIndicatorView/AppExtension` instead.
95110

96111
_**Note:** Related issue [#119](https://github.com/ninjaprox/NVActivityIndicatorView/issues/119)._
97112

98-
### Version 3.6.0
99-
100-
This version requires Xcode 8.3 and Swift 3.1.
101-
102-
### Version 3.0
103-
104-
This version requires Xcode 8.0 and Swift 3.
105-
106-
- `NVActivityIndicatorView.startAnimation()` and `NVActivityIndicatorView.stopAnimation()` are deleted. Use `NVActivityIndicatorView.startAnimating()` and `NVActivityIndicatorView.stopAnimating()` instead.
107-
- `UIViewController.startActivityAnimating()` and `UIViewController.stopActivityAnimating()` are deleted. Use `UIViewController.startAnimating()` and `UIViewController.stopAnimating()` instead.
108-
109-
### Version 2.0
110-
111-
This version continues to spport Xcode 7.0 and Swift 2.2 and earlier.
112-
For Swift 2.3 support, use `swift2.3` branch instead.
113-
114-
```ruby
115-
pod 'NVActivityIndicatorView', :git => 'https://github.com/ninjaprox/NVActivityIndicatorView.git', :branch => 'swift2.3'
116-
```
117-
118113
## Usage
119114

120115
Firstly, import `NVActivityIndicatorView`.
121116

122117
```swift
118+
// If you're using CocoaPods
123119
import NVActivityIndicatorView
120+
121+
// If you're using Carthage
122+
import NVActivityIndicatorView_iOS // for NVActivityIndicatorView_iOS.framework
123+
import NVActivityIndicatorView_tvOS // for NVActivityIndicatorView_tvOS.framework
124+
import NVActivityIndicatorViewAppExtension_iOS // for NVActivityIndicatorViewAppExtension_iOS.framework
124125
```
125126

126127
### Initialization
127128

128-
Then, there are two ways you can create NVActivityIndicatorView:
129+
Then, there are two ways you can create `NVActivityIndicatorView`:
129130

130131
- By storyboard, changing class of any `UIView` to `NVActivityIndicatorView`.
131132

0 commit comments

Comments
 (0)