Skip to content

Commit e132583

Browse files
chore: revert and fix readme (#117)
This reverts commit ca35a4e. * Update README.md to include a description of Unleash and the Android SDK
1 parent ca35a4e commit e132583

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ You can use this client with [Unleash Enterprise](https://www.getunleash.io/pric
1111

1212
## Getting started
1313

14-
This is the Android SDK for [Unleash Frontend API](https://docs.getunleash.io/reference/front-end-api) provided by the [Unleash server](https://github.com/Unleash/unleash) or [Unleash Edge](https://github.com/Unleash/unleash-edge).
14+
This is the Android SDK for [Unleash Frontend API](https://docs.getunleash.io/reference/front-end-api) provided by the [Unleash server](https://github.com/Unleash/unleash) or [Unleash Edge](https://github.com/Unleash/unleash-edge). It is a lightweight SDK that allows you to connect to the Unleash Frontend API and fetch feature toggles.
1515

1616
This supersedes the [previous Unleash Android Proxy SDK](https://github.com/Unleash/unleash-android-proxy-sdk/) this one is a an Android library instead of a Java library.
1717

@@ -29,7 +29,7 @@ You will require the SDK on your classpath, so go ahead and add it to your depen
2929

3030
#### Gradle
3131
```kotlin
32-
implementation("io.getunleash:unleash-android:"){unleash.sdk.version}
32+
implementation("io.getunleash:unleash-android:${unleash.sdk.version}")
3333
```
3434
#### Maven
3535

@@ -134,7 +134,7 @@ val toggles = listOf(
134134
instance.start(bootstrap = toggles)
135135
```
136136

137-
Alternatively, you can perform a query against the [frontend API](https://docs.getunleash.io/reference/front-end-api) using your HTTP client of choice and save the output as a json file. Then you can bootstrap Unleash with this file:
137+
Alternatively, you can perform a query against the [frontend API](https://docs.getunleash.io/reference/front-end-api) using your HTTP client of choice and save the output as a json file. Then you can tell Unleash to use this file to set up toggle states.
138138

139139
```kotlin
140140
val toggles = File("/tmp/proxyresponse.json")
@@ -170,11 +170,11 @@ unleash.getVariant("flag-with-variant").let { variant ->
170170
```
171171

172172
#### Example main activity
173-
In [the sample app](app/src/main/java/io/getunleash/unleashandroid/TestApplication.kt) we use this to display the state of a toggle on the [main activity](app/src/main/java/io/getunleash/unleashandroid/MainActivity.kt).
173+
In [the sample app](app/src/main/java/io/getunleash/unleashandroid/TestApplication.kt) we use this to display the state of a toggle on the [main activity](app/src/main/java/io/getunleash/unleashandroid/MainActivity.kt). We also configured a few event listeners to display how to use them.
174174

175175

176176
## Default behavior
177-
If you don't provide an initial state, Unleash will use the default behavior for feature toggles with unknown state. This means that if a feature toggle is not found in the list of toggles, it will return false.
177+
If you don't provide an initial state, Unleash will use the default behavior for feature toggles with unknown state. This means that if a feature toggle is not found in the list of toggles, it will be disabled by default.
178178

179179
## Releasing
180180

@@ -185,4 +185,4 @@ If you don't provide an initial state, Unleash will use the default behavior for
185185
- To release next patch version run `./gradlew release`
186186

187187
## Publishing to Maven central
188-
This is automatically handled when tags with v prefix is created in the repo. See `.github/workflows/release.yml`
188+
This is automatically handled when tags with v prefix is created in the repo. See `.github/workflows/release.yml`

0 commit comments

Comments
 (0)