Skip to content

Commit 942bdad

Browse files
author
Daniel Browne
committed
Remove redundant 'PusherSwiftWithEncryption' instructions from README.md
1 parent 783acee commit 942bdad

File tree

1 file changed

+2
-22
lines changed

1 file changed

+2
-22
lines changed

README.md

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,6 @@ What else would you want? Head over to one of our example apps:
6868

6969
[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects and is our recommended method of installing PusherSwift and its dependencies.
7070

71-
> If you are looking to use encrypted channels, please read the [specific installation instructions](#cocoapods-1).
72-
7371
If you don't already have the Cocoapods gem installed, run the following command:
7472

7573
```bash
@@ -106,8 +104,6 @@ Also you'll need to make sure that you've not got the version of PusherSwift loc
106104

107105
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application.
108106

109-
> If you are looking to use encrypted channels, please read the [specific installation instructions](#carthage-1).
110-
111107
You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
112108

113109
```bash
@@ -121,10 +117,7 @@ To integrate PusherSwift into your Xcode project using Carthage, specify it in y
121117
github "pusher/pusher-websocket-swift"
122118
```
123119

124-
Carthage will produce a number of frameworks. Which of those you need to include in you project depends on which features you are using:
125-
126-
- If you **are not** using the end-to-end encryption features, you need to include the following framework binaries from the `Carthage/Build` directory: `PusherSwift`
127-
- If you **are** using the end-to-end encryption features, you need to include the following framework binaries from the `Carthage/Build` directory: `PusherSwiftWithEncryption` and `TweetNacl`
120+
Carthage will produce a number of frameworks. You need to include the following framework binaries in your project from the `Carthage/Build` directory: `PusherSwift` and `TweetNacl`
128121

129122
#### Xcode 12 considerations
130123

@@ -162,7 +155,7 @@ let package = Package(
162155
)
163156
```
164157

165-
You will then need to include an `import PusherSwiftWithEncryption` statement in any source files where you wish to use the SDK. (**N.B. When integrating using Swift Package Manager, encrypted channels are supported by default and there is no 'PusherSwift' module**).
158+
You will then need to include an `import PusherSwift` statement in any source files where you wish to use the SDK.
166159

167160
## Configuration
168161

@@ -639,19 +632,6 @@ The shared secret used to decrypt events is loaded from the same auth endpoint r
639632
640633
Because of the requirement to reload the shared secret on demand, you can only use the following [auth methods](#configuration): `endpoint`, `authRequestBuilder`, `authorizer`. It is not possible to pass an instance of `PusherAuth` to the `subscribe` function if you are subscribing to an encrypted channel.
641634
642-
### Installation
643-
644-
In your Swift files, you will need to import `PusherSwiftWithEncryption` rather than `PusherSwift`. In Objective-C files, you will need to import `PusherSwiftWithEncryption/PusherSwiftWithEncryption-Swift.h` rather than `PusherSwift/PusherSwift-Swift.h`.
645-
646-
#### CocoaPods
647-
Update your Podfile to include `PusherSwiftWithEncryption` instead of `PusherSwift`.
648-
649-
#### Carthage
650-
You do not need to change your Cartfile. However, you will need to import the `PusherSwiftWithEncryption` framework into your project, instead of `PusherSwift`. You will also need to import the `TweetNacl` framework into your project.
651-
652-
#### Swift Package Manager
653-
Encrypted channels are supported by default when integrating using Swift Package Manager. No code or configuration changes are required.
654-
655635
#### Limitations
656636
657637
* Is not safe for use in extensions

0 commit comments

Comments
 (0)