Skip to content

Commit f47f6aa

Browse files
jaeoptthomaszurkan-optimizely
authored andcommitted
(chore): fix readme doc links (#202)
* fix README errors * fix per review * fix doc links in README to beta doc * fix cocoapods link and format errors * recover old doc links until doc released
1 parent 116d572 commit f47f6aa

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ Please note below that _\<platform\>_ is used to represent the platform on which
2727

2828
#### Cocoapod
2929
1. Add the following lines to the _Podfile_:<pre>
30-
```use_frameworks!```
31-
```pod 'OptimizelySwiftSDK', '3.1.0-beta```
32-
</pre>
30+
```use_frameworks!```
31+
```pod 'OptimizelySDK', :git => 'https://github.com/optimizely/swift-sdk.git', :branch => 'master'```
32+
</pre>
3333

3434
2. Run the following command: <pre>``` pod install ```</pre>
3535

@@ -38,22 +38,18 @@ Further installation instructions for Cocoapods: https://guides.cocoapods.org/us
3838
We haven't actually published to Cocoapods yet.
3939

4040
#### Carthage
41-
1. Add the following lines to the _Cartfile_:<pre>
42-
github "optimizely/swift-sdk" "master"
43-
</pre>
41+
1. Add the following lines to the _Cartfile_:<pre>```github "optimizely/swift-sdk" "master"```</pre>
4442

4543
2. Run the following command:<pre>```carthage update```</pre>
4644

47-
3. Link the frameworks to your project. Go to your project target's **Link Binary With Libraries** and drag over the following from the _Carthage/Build/\<platform\>_ folder: <pre>
48-
OptimizelySDK.framework
45+
3. Link the frameworks to your project. Go to your project target's **Link Binary With Libraries** and drag over the following from the _Carthage/Build/\<platform\>_ folder: <pre>```OptimizelySDK.framework```</pre>
4946

5047
4. To ensure that proper bitcode-related files and dSYMs are copied when archiving your app, you will need to install a Carthage build script:
5148
- Add a new **Run Script** phase in your target's **Build Phase**.</br>
5249
- In the script area include:<pre>
5350
```/usr/local/bin/carthage copy-frameworks```</pre>
5451
- Add the frameworks to the **Input Files** list:<pre>
55-
```$(SRCROOT)/Carthage/Build/<platform>/Optimizely.framework```
56-
</pre>
52+
```$(SRCROOT)/Carthage/Build/<platform>/Optimizely.framework```</pre>
5753

5854
Futher installation instructions for Carthage: https://github.com/Carthage/Carthage
5955

@@ -62,7 +58,7 @@ A sample code for SDK initialization and experiments:
6258
```
6359
let optimizely = OptimizelyClient(sdkKey:"somesdkkey")
6460
65-
optimizely.start(datafile:json) { result in
61+
optimizely.start{ result in
6662
do {
6763
let variation = try optimizely.activate(experimentKey: "background_experiment", userId: "userId", attributes: ["doubleKey":5])
6864
try optimizely.track(eventKey: "sample_conversion", userId: "userId")

0 commit comments

Comments
 (0)