Skip to content

Commit 5a88f83

Browse files
author
Vignesh Raja
authored
Fix READMEs (#77)
1 parent 81033b9 commit 5a88f83

File tree

2 files changed

+14
-20
lines changed

2 files changed

+14
-20
lines changed

README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# optimizely-ab-android-sdk
1+
# Optimizely Android SDK
22
Master<br/>
33
[![Master Status](https://travis-ci.org/optimizely/android-sdk.svg?branch=master)](https://travis-ci.org/optimizely/android-sdk)
44
<br/>
@@ -12,11 +12,9 @@ Devel<br/>
1212
[![Apache 2.0](https://img.shields.io/github/license/nebula-plugins/gradle-extra-configurations-plugin.svg)](http://www.apache.org/licenses/LICENSE-2.0)
1313
## Overview
1414

15-
Our Optimizely X Android solution allows you to easily run experiments anywhere in an Android application, even Services. The solution includes easy-to-use SDKs for experimenting in your code and tracking conversion events in Optimizely.
15+
This repository houses the Android SDK for Optimizely's Mobile product. To find out more check out the [documentation](https://developers.optimizely.com/x/solutions/sdks/introduction/index.html?language=android&platform=mobile).
1616

17-
To find out more check out the [documentation](https://developers.optimizely.com/x/solutions/sdks/introduction/index.html?language=android&platform=mobile).
18-
19-
This repo depends on [Optimizely X Java](https://github.com/optimizely/java-sdk).
17+
This repo depends on the [Optimizely Java SDK](https://github.com/optimizely/java-sdk).
2018

2119
## Architecture
2220

@@ -27,13 +25,13 @@ root declares modules. The `build.gradle` in the project root has build
2725
config common for all modules.
2826

2927
1. Android SDK
30-
- Users who want all modules should just declare a dependency on this module
28+
- Users who want all modules should declare a dependency on this module
3129
- This is the outer module that depends on all other modules
32-
- Handles downloading the Optimizely Data File and building Optimizely objects
30+
- Handles downloading the Optimizely datafile and building Optimizely objects
3331
- Delivers the built Optimizely object to listeners and caches it in memory
3432
2. Event Handler
35-
- Handles dispatching events to the Optimizely Backend
36-
- Uses a Service so events can be sent without the app being reopened
33+
- Handles dispatching events to the Optimizely backend
34+
- Uses a Service so events can be sent without the app being re-opened
3735
- Persists events in a SQLite3 database
3836
- Required to be implemented by the Optimizely Java core
3937
3. User Profile
@@ -51,10 +49,8 @@ config common for all modules.
5149
### Command Line
5250

5351
1. Clone the repo
54-
* `git clone [email protected]:optimizely/optimizely-ab-android-sdk.git`
55-
3. Create, or use an existing, Optimizely Custom Project
56-
* put a file in `test-app/src/main/res/values/git_ignored_strings.xml`
57-
* Give it this contents `<resources><string name="optly_project_id">{CUSTOM_PROJECT_ID}</string></resources>`
52+
* `git clone [email protected]:optimizely/android-sdk.git`
53+
3. Create, or use an existing, Optimizely Android project
5854
4. Build the project (from the project root)
5955
* `./gradlew assemble`
6056
5. Run tests for all modules
@@ -84,7 +80,7 @@ The default branch is devel. Feature branch PRs are automatically made against
8480

8581
Versions are managed via git tags. Tags can be created from the command line or from the Github UI.
8682

87-
Snapshot builds are made off of the beta branch. Travis will test all commits to this branch. When commit is tagged and pushed travis will build, test, *and*, ship the build bintray. The version name used
83+
Snapshot builds are made off of the beta branch. Travis will test all commits to this branch. When a commit is tagged and pushed, Travis will build, test, *and*, ship the build to Bintray. The version name used
8884
is the name of the tag. For snapshot builds the version should have `-SNAPSHOT` appended. For example `0.1.2-SNAPSHOT`. Multiple builds with the same version can be pushed to Bintray when using snapshot versions.
8985
This keeps the version number from increasing too quickly for beta builds. Grade and maven ensure that users are on the latest snapshot via timestamps.
9086
There can be only one git tag per version name so snapshot tags may need to be moved. For example `git tag -f -a 0.1.2` and `git push -f --tags`.

test-app/README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ is also used to run integration tests on using the Android Espresso framework.
55

66
## Experiments Run
77

8-
The experiments run in this demo app are part of the [email protected] account.
9-
108
We run the following experiment:
119
- Background change in second activity, which is loaded after the splash screen.
1210

@@ -15,12 +13,12 @@ We run the following experiment:
1513
The SDK is implemented in the following way:
1614
- The splash screen initializes the Optimizely manager asynchronously. This starts the datafile
1715
fetch.
18-
- Once the datafile is fetched and the Optimizely manager is started, we use grab the `optimizelyClient`
19-
from the manager and use it to activate the `background_experiment`. This buckets the user and sends
16+
- Once the datafile is fetched and the Optimizely manager is started, we grab the `optimizelyClient`
17+
from the manager and use it to activate the experiment named `background_experiment`. This buckets the user and sends
2018
an impression event.
2119
- We then use the bucketed variation to determine which activity to show. `VariationAActivity` for
22-
`variation_a` and `VariationBActivity` for `variation_b`.
23-
- Each of those activities include a `Test Conversion` button.
20+
`variation_a`, `VariationBActivity` for `variation_b`, or `ActivationErrorActivity` for the control.
21+
- Each of the variation activities includes a `Test Conversion` button.
2422
- Clicking on that button will call `optimizelyClient.track()` and send a conversion event for the
2523
event named `sample_conversion`.
2624
- Then the application will navigate to the conversion page to confirm that a conversion event has

0 commit comments

Comments
 (0)