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

Commit 08806c5

Browse files
readme: updating main readme for compat changes
GitOrigin-RevId: 090204343b040dab82c1b46315f010323182efdc
1 parent 33bda5b commit 08806c5

File tree

1 file changed

+2
-11
lines changed

1 file changed

+2
-11
lines changed

README.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Use the Kin SDK for Android to enable the use of Kin inside of your app. Include
99
| Library                              | Support | Path                     | Description |
1010
|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
1111
| `base` | <img src="assets/java.png" height="24">&nbsp;<img src="assets/kotlin.png" height="24"> | [`/base`](base) | The foundation library used by all other libraries in the system to support basic Kin operations: <ul><li>Wallet creation and management</li><li>Send and receive Kin</li><li>Metrics interfaces</li></ul> |
12-
| `base-compat` | <img src="assets/android.png" height="24">&nbsp;<img src="assets/kotlin.png" height="24"> | [`/base-compat`](base-compat) | The [:base-compat](base-compat) library implements the public surface layer to be a drop in replacement of the, now deprecated, [kin-sdk-android](https://github.com/kinecosystem/kin-sdk-android) library. Just update your version in gradle and have better performance and stability. |
12+
| `base-compat` | <img src="assets/android.png" height="24">&nbsp;<img src="assets/kotlin.png" height="24"> | [`/base-compat`](base-compat) | The [:base-compat](base-compat) library now only contains the backup & restore flow retrofitted on top of base. If you're using an old version of base-compat please consider upgrading to base. |
1313
| `design` | <img src="assets/android.png" height="24">&nbsp;<img src="assets/kotlin.png" height="24"> | [`/design`](design) | Shared [:design](design) library components for creating consistent Kin user experiences. When creating a custom Kin experience, this library can be used to include standard UI components for displaying Kin prices, transactions, etc. |
1414
| `spend` | <img src="assets/android.png" height="24">&nbsp;<img src="assets/kotlin.png" height="24"> | [`/spend`](spend) | The [:spend](spend) library provides an out of the box model UI for spending Kin within an Android application. Specificy what you're buying, your account, tap confirm. Success.|
1515

@@ -29,12 +29,9 @@ buildscript {
2929
dependencies {
3030
// ...
3131
32-
// *** base-compat is for LEGACY SUPPORT ONLY ***
33-
// If you're a longtime Kin developer and want to use the compat
34-
// interface that looks like the now deprecated SDKS
32+
// *** base-compat is for backup and restore support ONLY ***
3533
implementation "org.kin.sdk.android:base-compat:${versions.kin}"
3634
37-
3835
// If you're a new developer or want more functionality you want a
3936
// mix of the libraries below:
4037
@@ -47,12 +44,6 @@ dependencies {
4744
// Add design for direct access to UI views you can use in your own app
4845
implementation "org.kin.sdk.android:design:${versions.kin}"
4946
}
50-
repositories {
51-
// ...
52-
mavenCentral()
53-
jcenter()
54-
maven { url "https://jitpack.io/" } // Jitpack is used for OkSSE fork only
55-
}
5647
```
5748

5849
## Demo App

0 commit comments

Comments
 (0)