Skip to content

Commit 390c464

Browse files
[FSSDK-8952] doc: Full Stack to Feature Experimentation Rename (#450)
* [FSSDK-8952] doc: Full Stack to Feature Experimentation Rename --------- Co-authored-by: mnoman09 <[email protected]>
1 parent 184f426 commit 390c464

File tree

3 files changed

+37
-13
lines changed

3 files changed

+37
-13
lines changed

README.md

Lines changed: 35 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,20 @@
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
[![Build Status](https://travis-ci.org/optimizely/android-sdk.svg?branch=master)](https://travis-ci.org/optimizely/android-sdk)
44

5-
## Overview
5+
This repository houses the Android SDK for use with Optimizely Feature Experimentation and Optimizely Full Stack (legacy). The Android SDK depends on the [Optimizely Java SDK](https://github.com/optimizely/java-sdk).
66

7-
This repository houses the Android SDK for use with Optimizely Full Stack and Optimizely Rollouts. The Android SDK depends on the [Optimizely Java SDK](https://github.com/optimizely/java-sdk).
7+
Optimizely Feature Experimentation is an A/B testing and feature management tool for product development teams, letting you 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).
88

9-
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).
9+
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.
1010

11-
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).
11+
## Get Started
1212

13-
## Getting Started
14-
15-
### Using the SDK
16-
See the [Android SDK developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/install-sdk-android) to learn how to set
17-
up an Optimizely project and start using the SDK.
13+
Refer to the [Android SDK's developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/android-sdk) for detailed instructions on getting started with using the SDK.
1814

1915
### Requirements
2016
* Android API 14 or higher
2117

22-
### Installing the SDK
18+
### Install the SDK
2319
To add the android-sdk and all modules to your project, include the following in your app's `build.gradle`:
2420

2521
---
@@ -60,6 +56,10 @@ optimizelyManager.initialize(this, null, (OptimizelyClient optimizely) -> {
6056
6157
```
6258

59+
## Use the Android SDK
60+
61+
See the Optimizely Feature Experimentation [developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0-full-stack/docs/android-sdk) to learn how to set up your first Android project and use the SDK.
62+
6363
## Architecture
6464

6565
This project includes 5 library modules and a test app.
@@ -82,7 +82,7 @@ This project includes 5 library modules and a test app.
8282
6. Test App
8383
- A simple app showing how to use the Optimizely Android SDK
8484

85-
## Development
85+
## SDK Development
8686

8787
### Command Line
8888

@@ -111,6 +111,7 @@ You can import this project into Android Studio by opening Android Studio and se
111111
Tests can be run by right clicking the file in the project pane or by clicking the method name in source and selecting run. You will be prompted to create an AVD or connect a device if one isn't connected.
112112

113113
### Contributing
114+
114115
Please see [CONTRIBUTING](CONTRIBUTING.md).
115116

116117
### Credits
@@ -128,3 +129,26 @@ Additional credits from java-sdk:[https://github.com/optimizely/java-sdk/blob/ma
128129
**Android Logger** [https://github.com/noveogroup/android-logger](https://github.com/noveogroup/android-logger)
129130
License (Public Domain): [https://github.com/noveogroup/android-logger/blob/master/LICENSE.txt](https://github.com/noveogroup/android-logger/blob/master/LICENSE.txt)
130131

132+
### Other Optimzely SDKs
133+
134+
- Agent - https://github.com/optimizely/agent
135+
136+
- C# - https://github.com/optimizely/csharp-sdk
137+
138+
- Flutter - https://github.com/optimizely/optimizely-flutter-sdk
139+
140+
- Go - https://github.com/optimizely/go-sdk
141+
142+
- Java - https://github.com/optimizely/java-sdk
143+
144+
- JavaScript - https://github.com/optimizely/javascript-sdk
145+
146+
- PHP - https://github.com/optimizely/php-sdk
147+
148+
- Python - https://github.com/optimizely/python-sdk
149+
150+
- React - https://github.com/optimizely/react-sdk
151+
152+
- Ruby - https://github.com/optimizely/ruby-sdk
153+
154+
- Swift - https://github.com/optimizely/swift-sdk

build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ configure(publishedProjects) {
217217

218218
customizePom(pom, docTitle)
219219
// "description" is required by MavenCentral but it does not work in customizePom(). added here explicitly.
220-
pom.description = 'The Android SDK for Optimizely Full Stack (feature flag management for product development teams)'
220+
pom.description = 'The Android SDK for Optimizely Feature Experimentation, Optimizely Full Stack (legacy), and Optimizely Rollouts'
221221

222222
from components.release
223223
}

test-app/build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ android {
3838
}
3939

4040
dependencies {
41-
// Includes the Optimizely X Full Stack Java SDK, event handler, and user profile
41+
// Includes the Optimizely Feature Experimentation, Optimizely Full Stack (legacy), and Optimizely Rollouts Java SDK, event handler, and user profile
4242
//implementation "com.optimizely.ab:android-sdk:1.0.0"
4343
implementation (project(':android-sdk')) {
4444
exclude group: 'com.google.code.gson', module:'gson'

0 commit comments

Comments
 (0)