Skip to content

Commit e638360

Browse files
authored
[FSSDK-8951]: Updates readme replacing Full Stack with Feature Experimentation. (#479)
1 parent 3fce84a commit e638360

File tree

1 file changed

+42
-13
lines changed

1 file changed

+42
-13
lines changed

README.md

Lines changed: 42 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,29 @@
1-
# SWIFT SDK
1+
# Optimizely Swift SDK
22
[![Apache 2.0](https://img.shields.io/github/license/nebula-plugins/gradle-extra-configurations-plugin.svg)](http://www.apache.org/licenses/LICENSE-2.0)
33
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/carthage/carthage)
44
[![Build Status](https://github.com/optimizely/swift-sdk/actions/workflows/swift.yml/badge.svg?branch=master)](https://github.com/optimizely/swift-sdk/actions)
55
[![Coverage Status](https://coveralls.io/repos/github/optimizely/swift-sdk/badge.svg?branch=master)](https://coveralls.io/github/optimizely/swift-sdk?branch=master)
66
[![Platforms](https://img.shields.io/cocoapods/p/OptimizelySwiftSDK.svg)](https://img.shields.io/cocoapods/p/OptimizelySwiftSDK.svg)
77
[![Podspec](https://img.shields.io/cocoapods/v/OptimizelySwiftSDK.svg)](https://cocoapods.org/pods/OptimizelySwiftSDK)
88

9-
This repository houses the Swift SDK for use with Optimizely Full Stack and Optimizely Rollouts for Mobile and OTT.
9+
This repository houses the Swift SDK for use with Optimizely Feature Experimentation and Optimizely Full Stack (legacy) for Mobile and OTT.
1010

11-
Optimizely Full Stack is A/B testing and feature flag management for product development teams. Experiment in any application. Make every feature on your roadmap an opportunity to learn. Learn more at https://www.optimizely.com/platform/full-stack/, or see the [documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/welcome).
11+
Optimizely Feature Experimentation is an A/B testing and feature management tool for product development teams, enabling you to experiment at every step. Using Optimizely Feature Experimentation allows for every feature on your roadmap to be an opportunity to discover hidden insights. Learn more at [Optimizely.com](https://www.optimizely.com/products/experiment/feature-experimentation/), or see the [developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/welcome).
1212

13-
Optimizely Rollouts is free feature flags for development teams. Easily roll out and roll back features in any application without code deploys. Mitigate risk for every feature on your roadmap. Learn more at https://www.optimizely.com/rollouts/, or see the [documentation](https://docs.developers.optimizely.com/experimentation/v3.1.0-full-stack/docs/introduction-to-rollouts).
13+
Optimizely Rollouts is [free feature flags](https://www.optimizely.com/free-feature-flagging/) for development teams. You can easily roll out and roll back features in any application without code deploys, mitigating risk for every feature on your roadmap.
1414

1515

16-
## Getting Started
16+
## Get started
1717

18-
### Using the SDK
18+
### Use the Swift SDK
1919

20-
See the [Swift SDK developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/swift-sdk) to learn how to set
21-
up an Optimizely project and start using the SDK.
20+
Refer to the [Swift SDK's developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/swift-sdk) for detailed instructions on getting started with using the SDK.
2221

2322
### Requirements
2423
* iOS 10.0+ / tvOS 10.0+ / watchOS 3.0+
2524
* Swift 5+
2625

27-
### Installing the SDK
26+
### Install the SDK
2827

2928
Please note below that _\<platform\>_ is used to represent the platform on which you are building your app. Currently, we support ```iOS```, ```tvOS```, and ```watchOS``` platforms.
3029

@@ -40,15 +39,15 @@ If you have a name conflict with other swift packages when you add the Optimizel
4039
#### CocoaPods
4140
1. Add the following lines to the _Podfile_:<pre>
4241
```use_frameworks!```
43-
```pod 'OptimizelySwiftSDK', '~> 3.10.1'```
42+
```pod 'OptimizelySwiftSDK', '~> 3.10.2'```
4443
</pre>
4544

4645
2. Run the following command: <pre>``` pod install ```</pre>
4746

4847
Further installation instructions for Cocoapods: https://guides.cocoapods.org/using/getting-started.html
4948

5049
#### Carthage
51-
1. Add the following lines to the _Cartfile_:<pre>```github "optimizely/swift-sdk" ~> 3.10.1```</pre>
50+
1. Add the following lines to the _Cartfile_:<pre>```github "optimizely/swift-sdk" ~> 3.10.2```</pre>
5251

5352
2. Run the following command:<pre>```carthage update```</pre>
5453

@@ -65,6 +64,12 @@ Further installation instructions for Cocoapods: https://guides.cocoapods.org/us
6564

6665
Futher installation instructions for Carthage: https://github.com/Carthage/Carthage
6766

67+
### Feature Management Access
68+
69+
To access the Feature Management configuration in the Optimizely dashboard, please contact your Optimizely customer success manager.
70+
71+
## Use the Swift SDK
72+
6873
### Samples
6974

7075
A sample code for SDK initialization and experiments:
@@ -82,6 +87,8 @@ optimizely.start{ result in
8287
}
8388
```
8489

90+
See the Optimizely Feature Experimentation [developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0-full-stack/docs/swift-sdk) to learn how to set up your first Swift project and use the SDK.
91+
8592

8693
### Contributing
8794
Please see [CONTRIBUTING](CONTRIBUTING.md).
@@ -92,12 +99,34 @@ First-party code (under OptimizelySwiftSDK is copyright Optimizely, Inc. and con
9299

93100
### Additional Code
94101

95-
This software incorporates code from the following open source repo:
102+
This software incorporates code from the following open source projects:
96103

97-
For the SDK:
98104
MurmurHash3:https://github.com/jpedrosa/sua/blob/master/Sources/murmurhash3.swift License (Apache 2.0):https://github.com/jpedrosa/sua/blob/master/LICENSE.txt
99105
Ported to Swift4.
100106

101107
SwiftLint:https://github.com/realm/SwiftLint License (MIT):https://github.com/realm/SwiftLint/blob/master/LICENSE
102108
Used to enforce Swift style and conventions.
103109

110+
### Other Optimizely SDKs
111+
112+
- Agent - https://github.com/optimizely/agent
113+
114+
- Android - https://github.com/optimizely/android-sdk
115+
116+
- C# - https://github.com/optimizely/csharp-sdk
117+
118+
- Flutter - https://github.com/optimizely/optimizely-flutter-sdk
119+
120+
- Go - https://github.com/optimizely/go-sdk
121+
122+
- Java - https://github.com/optimizely/java-sdk
123+
124+
- JavaScript - https://github.com/optimizely/javascript-sdk
125+
126+
- PHP - https://github.com/optimizely/php-sdk
127+
128+
- Python - https://github.com/optimizely/python-sdk
129+
130+
- React - https://github.com/optimizely/react-sdk
131+
132+
- Ruby - https://github.com/optimizely/ruby-sdk

0 commit comments

Comments
 (0)