Skip to content
This repository has been archived by the owner on Nov 22, 2022. It is now read-only.

Commit

Permalink
readme: update base-compat readme to include b&r
Browse files Browse the repository at this point in the history
GitOrigin-RevId: f5458a50d09d4f18b2947587512819c5cafe5080
  • Loading branch information
kikengineering committed May 27, 2021
1 parent 6ae3ebe commit 33bda5b
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions base-compat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,11 @@ This version is based on the new [:base](../base/README.md) module under the cov
Android API 19+

## Installation
If you're currently making use of [kin-sdk-android](https://github.com/kinecosystem/kin-sdk-android) please upgrade your gradle files accordingly:
In the old [kin-sdk-android](https://github.com/kinecosystem/kin-sdk-android) sdk you would have had this:
```groovy
dependencies {
// ...
implementation 'com.github.kinecosystem.kin-sdk-android:kin-sdk-lib:1.0.7'
}
```
Now, replace that with the following and do a clean build:
```groovy
dependencies {
// ...
implementation "org.kin.sdk.android:base-compat:${versions.kin}"
}
repositories {
// ...
jcenter()
maven { url "https://jitpack.io/" } // Jitpack is used for OkSSE fork only
}
```
Alternatively...there is a shaded artifact for those that are having difficuly resolving common dependencies (e.g. grpc, guava, other google transitive deps)
```groovy
Expand All @@ -42,5 +28,17 @@ If you are still encountering difficulties with dependency collisions with this

Otherwise, if you're not using [kin-sdk-android](https://github.com/kinecosystem/kin-sdk-android), please checkout [:base](../base).

## Backup & Restore
As of 1.0.0+ base-compat *only* contains the backup and restore flow, which has been retrofitted with direct support with the base module.
to backup you can call the followowing to start that ui flow:
```kotlin
BackupAndRestoreManager(activity, 1, 2)
.backup(kinEnvironment, KinAccount.Id(accountAddressString))
```
and to retore you can call the followowing to start that ui flow:
```kotlin
BackupAndRestoreManager(launchActivity, 1, 2).restore(kinEnvironment)
```

## Documentation
[kin-sdk-android](https://github.com/kinecosystem/kin-sdk-android) is now **Deprecated** but see the [old documentation](https://github.com/kinecosystem/kin-sdk-android/tree/master/kin-sdk) or [API reference](../docs) for more details on how to use it.

0 comments on commit 33bda5b

Please sign in to comment.