diff -r 33ee5f3d6466 -r f1e51fe391c2 README.md --- a/README.md Mon May 05 17:09:13 2025 -0400 +++ b/README.md Mon May 05 17:10:13 2025 -0400 @@ -1,42 +1,24 @@ AboutOss ========== -AboutOss is an utility library to retrieve and display opensource licenses in Android applications. - -Usage -===== - -The library works with the [OSS Licenses Gradle Plugin](https://github.com/google/play-services-plugins/tree/master/oss-licenses-plugin). -You can integrate it in your application with few simple steps. +AboutOss is a Kotlin Multiplatform utility library to retrieve and display opensource licenses in your applications. -### Apply the OSS Licenses Gradle Plugin - -In your app-level `build.gradle`, apply the plugin by adding the following line under the existing `apply plugin: 'com.android.application'` at the top of the file: +License sources +--------------- -```kotlin title="build.gradle.kts" -apply plugin: 'com.google.android.gms.oss-licenses-plugin' -``` - -### Add the ui library to your application +The library can work with license information files generated by: -```kotlin title="build.gradle.kts" -repositories { - maven { - url = uri("https://jitpack.io") - } -} +- [OSS Licenses Gradle Plugin](https://github.com/google/play-services-plugins/tree/main/oss-licenses-plugin) +- [licensee](https://github.com/cashapp/licensee) +- [LicensePlist](https://github.com/mono0926/LicensePlist) -dependencies { - implementation("com.geekorum.aboutoss:ui-material:0.0.1") -} -``` +User interface +-------------- -### Launch the license activity +The user interface to display license information is written in [Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform). +There is out of the box composables for Material and Material3 and you can easily write your own UI. -```kotlin -val intent = Intent(this, OpenSourceLicensesActivity::class.java) -startActivity(intent) -``` +Check the sample [here](https://github.com/fbarthelery/AboutOss/tree/main/sample) Build instructions ==================