diff --git a/README.md b/README.md index 3413e51..b9fbe85 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Roboswag позволяет сочетать эти три решения в о ### Работа с RecyclerView RecyclerView - один из самых часто используемых инструментов Android разработчика. Модуль [recyclerview-adapters](/recyclerview-adapters) позволяет сделать работу с RecyclerView более гибкой и делает работу самого элемента быстрее. ### Работа с SharedPreferences -Чтобы сохранять простые данные в память смартфона, используются SharedPreferences. Модуль [storable](/storable) разработан для облегчения работы с SharedPreferences. +Чтобы сохранять простые данные в память смартфона, используются SharedPreferences. Модуль [storable](/storable) разработан для облегчения работы с SharedPreferences. Для шифрования данных в SharedPreferences можно использовать [encrypted-shared-prefs](/encrypted-shared-prefs) ### Утилиты и extension функции В Roboswag также есть много [утилитарных](/utils) классов и [extension](/kotlin-extensions) функций, которые позволяют писать часто используемый код в одну строку. @@ -62,7 +62,8 @@ gradle.ext.roboswag = [ 'tabbar-navigation', 'base-map', 'yandex-map', - 'google-map' + 'google-map', + 'encrypted-shared-prefs' ] gradle.ext.roboswag.forEach { module -> diff --git a/encrypted-shared-prefs/README.md b/encrypted-shared-prefs/README.md new file mode 100644 index 0000000..1b72271 --- /dev/null +++ b/encrypted-shared-prefs/README.md @@ -0,0 +1,14 @@ +Encrypted shared preferences +============================ + +Модуль с реализацией интерфейса `SharedPreferences`, который дает возможность шифровать содержимое. + +### Пример + +Пример создания получения экземпляра `TouchinSharedPreferences`. При isEncryption = false, `TouchinSharedPreferences` абсолютно аналогичны стандартной реализации `SharedPreferences` + +```kotlin +val prefs = TouchinSharedPreferences(name = "APPLICATION_DATA_ENCRYPTED", context = context, isEncryption = true) +``` + +Важно помнить, что в одном файле `TouchinSharedPreferences` могут храниться только либо полностью зашифрованные данные, либо полностью незашифрованные. Флаг `isEncryption` должен быть в соответствующем положении \ No newline at end of file