Skip to content

Commit 8e7eac6

Browse files
committed
feature: update readme with about app plugin
1 parent 6cb3edc commit 8e7eac6

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,9 @@ dependencies {
6262
debugImplementation 'com.redmadrobot.debug:plugin-konfeature:${debug_panel_version}'
6363
//Так же необходимо подключить саму библиотеку konfeature
6464
debugImplementation "com.redmadrobot.konfeature:konfeature:${konfeature_version}"
65+
66+
//Плагин для отображения информации о приложении
67+
debugImplementation 'com.redmadrobot.debug:plugin-about-app:${debug_panel_version}'
6568
}
6669
6770
```
@@ -328,6 +331,31 @@ KonfeaturePlugin(
328331
- настроить работу с remote config через реализацию интерфейса `FeatureSource` - `addSource(featureSource)`
329332
- настроить логирование - `setLogger(logger)`
330333

334+
### AboutApp Plugin
335+
336+
Используется для отображения информации о приложении: версии, номера билда и других произвольных данных.
337+
338+
Для подключения плагина необходимо передать список `AboutAppInfo`. Требуется хотя бы один элемент:
339+
340+
```kotlin
341+
AboutAppPlugin(
342+
aboutAppInfo = listOf(
343+
AboutAppInfo(
344+
title = "Версия",
345+
content = BuildConfig.VERSION_NAME
346+
),
347+
AboutAppInfo(
348+
title = "Номер билда",
349+
content = BuildConfig.VERSION_CODE.toString()
350+
)
351+
)
352+
)
353+
```
354+
355+
Каждый `AboutAppInfo` содержит:
356+
- `title` — название поля (например, «Версия»)
357+
- `content` — значение поля (например, «1.0.0»)
358+
331359
# Безопасность!
332360
Для того чтобы тестовые данные не попали в релизные сборки рекомендуется не задавать их явно в Application классе, а использовать реализации DebugDataProvider, которые можно разнести по разным buildType. Для release версии следует сделать пустую реализацию.
333361

0 commit comments

Comments
 (0)