Skip to content

Commit 3923b57

Browse files
committed
- remove duplicated info
- refine README further
1 parent d60fd81 commit 3923b57

File tree

1 file changed

+2
-19
lines changed

1 file changed

+2
-19
lines changed

README.md

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![Gradle Plugin Portal](https://img.shields.io/gradle-plugin-portal/v/com.mikepenz.aboutlibraries.plugin?label=Gradle%20Plugin&style=for-the-badge)](https://plugins.gradle.org/plugin/com.mikepenz.aboutlibraries.plugin)
66
[![Apache 2.0 License](https://img.shields.io/github/license/mikepenz/AboutLibraries?style=for-the-badge)](https://github.com/mikepenz/AboutLibraries/blob/develop/LICENSE)
77

8-
.. collects dependency details including licenses at compile time, and offers simple APIs to visualize these in the app.
8+
This library collects dependency details, including licenses at compile time, and offers simple APIs to visualize these in the app.
99
*No runtime overhead.* Strong caching. Supports any Gradle dependency.
1010

1111
-------
@@ -521,24 +521,7 @@ Generate the file manually using the Gradle task:
521521
./gradlew :app:exportLibraryDefinitions -PaboutLibraries.outputFile=src/main/res/raw/libraries.json -PaboutLibraries.exportVariant=release
522522
```
523523

524-
Commit the generated `aboutlibraries.json` to your SCM. The library will then need to load this file manually.
525-
526-
Example for Compose UI:
527-
528-
```kotlin
529-
// Load the JSON from Android resources
530-
LibrariesContainer(
531-
librariesBlock = { ctx ->
532-
Libs.Builder().withContext(ctx).build()
533-
}
534-
)
535-
536-
// Load the JSON using compose-resources
537-
val libraries by rememberLibraries {
538-
Res.readBytes("files/aboutlibraries.json").decodeToString()
539-
}
540-
LibrariesContainer(libraries)
541-
```
524+
Commit the generated `aboutlibraries.json` to your SCM. The library will then need to load this file manually. See details in [Usage](#usage).
542525

543526
## Gradle API / Tasks
544527

0 commit comments

Comments
 (0)