Skip to content

Commit

Permalink
Update DEVELOPMENT docs regarding use of the Proto datastore
Browse files Browse the repository at this point in the history
  • Loading branch information
jkuester committed Jan 2, 2024
1 parent 1dae8cd commit 95320f2
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
10 changes: 10 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Developing Unlauncher

## Adding a new configuration preference

Currently user preferences in the Unlauncher code base are stored in one of three different ways:

1. In the [SharedPreferences](https://developer.android.com/training/data-storage/shared-preferences). This is an older style of storing basic preferences that was inherited from Slim Launcher.
1. In an [SQLite database](https://developer.android.com/training/data-storage/sqlite). This format is more appropriate for storing large amounts of data and was inherited from Slim Launcher as the method for storing data about the apps installed on the device.
1. In a [Proto DataStore](https://developer.android.com/topic/libraries/architecture/datastore#proto-datastore). This data format is suitable for both simple user preference values as well as storing larger data sets.

The plan is to eventually migrate away from SharedPreferences and SQLite so that all the data is centralized in Proto DataStores. This will maximize consistency and simplicity in the codebase. All new data values should be added to Proto DataStores.

## Building a release

Building an Unlauncher release is straightforward.
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,12 @@ Features:

## What people are saying

<!-- 2023 -->
Jake Ginesin - [dumb-phone](https://jakegines.in/blog/2023/dumb-phone)

<!-- 2022-12-05 -->
Side Of Burritos - [A minimalist dumb phone you should actually use](https://www.youtube.com/watch?v=OrZacTUhH0c) (VIDEO)

<!-- 2020-11-13 -->
zymotux - [Bare-bones smartphone “Unlauncher”](https://write.as/zymotux/bare-bones-smartphone-unlauncher)

Expand Down

0 comments on commit 95320f2

Please sign in to comment.