Skip to content

Commit 3f619cb

Browse files
Update README
1 parent de89ed1 commit 3f619cb

File tree

1 file changed

+15
-17
lines changed

1 file changed

+15
-17
lines changed

README.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -51,40 +51,38 @@ See the Contributing section below for more details.
5151

5252
#### CocoaPods
5353

54-
The easiest way to install XMPPFramework is using CocoaPods. Remember to add to the top of your `Podfile` the `use_frameworks!` line (even if you are not using swift):
54+
The easiest way to install XMPPFramework is using CocoaPods.
5555

56-
This will install the whole framework with all the available extensions:
56+
To install only the Objective-C portion of the framework:
5757

5858
```ruby
59-
use_frameworks!
60-
# 3.7 Stable Release
61-
pod 'XMPPFramework', '~> 3.7.0'
62-
# 4.0 Preview / Master Branch
63-
pod 'XMPPFramework', :git => 'https://github.com/robbiehanson/XMPPFramework.git', :branch => 'master'
59+
pod 'XMPPFramework'
60+
```
6461

65-
# XMPPFramework with Swift extensions
66-
pod 'XMPPFramework/Swift', :git => 'https://github.com/robbiehanson/XMPPFramework.git', :branch => 'master'
62+
To use the new Swift additions:
6763

64+
65+
```
66+
use_frameworks!
67+
pod 'XMPPFramework/Swift'
6868
```
6969

7070
After `pod install` open the `.xcworkspace` and import:
7171

72+
```objc
73+
@import XMPPFramework; // Objective-C
7274
```
73-
import XMPPFramework // swift
74-
@import XMPPFramework; //objective-c
75+
76+
```swift
77+
import XMPPFramework // Swift
7578
```
7679

7780
#### Carthage
7881

7982
To integrate XMPPFramework into your Xcode project using Carthage, specify it in your `Cartfile`:
8083

8184
```
82-
# ⚠️ Carthage support is currently experimental ⚠️
83-
# For now, use the master branch until a Carthage-compatible
84-
# tagged release is available.
85-
86-
github "robbiehanson/XMPPFramework" "master"
87-
85+
github "robbiehanson/XMPPFramework"
8886
```
8987

9088
Run `carthage` to build the framework and drag the built `XMPPFramework.framework` into your Xcode project. If you'd like to include new features written in Swift, drag `XMPPFrameworkSwift.framework` into your project as well. You'll need to manually `import XMPPFrameworkSwift` in your headers.

0 commit comments

Comments
 (0)