docs: add badges and some intro to license-sources
authorDa Risk <da_risk@geekorum.com>
Tue, 06 May 2025 13:02:36 -0400
changeset 90 260a6b232f4d
parent 89 0cc872a9edbf
child 91 b3b57696b660
docs: add badges and some intro to license-sources
README.md
docs/license-sources.md
--- a/README.md	Tue May 06 12:55:03 2025 -0400
+++ b/README.md	Tue May 06 13:02:36 2025 -0400
@@ -1,8 +1,15 @@
+[![Release Version](https://img.shields.io/maven-central/v/com.geekorum.aboutoss/core?label=release)](https://search.maven.org/#search%7Cga%7C1%7Caboutoss)
+[![License](https://img.shields.io/github/license/fbarthelery/AboutOss)](https://github.com/fbarthelery/AboutOss/blob/main/LICENSE)
+
 AboutOss
 ==========
 
 AboutOss is a Kotlin Multiplatform utility library to retrieve and display opensource licenses in your applications.
 
+```kotlin title="build.gradle.kts"
+implementation("com.geekorum.aboutoss:ui-material3:<latest-version>")
+```
+
 License sources
 ---------------
 
@@ -12,6 +19,8 @@
 - [licensee](https://github.com/cashapp/licensee)
 - [LicensePlist](https://github.com/mono0926/LicensePlist)
 
+See [license sources](license-sources.md) for more information
+
 User interface
 --------------
 
--- a/docs/license-sources.md	Tue May 06 12:55:03 2025 -0400
+++ b/docs/license-sources.md	Tue May 06 13:02:36 2025 -0400
@@ -1,6 +1,12 @@
 License sources
 ===============
 
+The library can work with license information files generated by:
+
+- [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)
+
 Setup
 =====