Skip to content
This repository was archived by the owner on Sep 16, 2023. It is now read-only.

Commit 062a4b7

Browse files
author
eightgran
committed
Update README
1 parent 84d4a7d commit 062a4b7

File tree

5 files changed

+18
-12
lines changed

5 files changed

+18
-12
lines changed

README.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,28 +31,33 @@ This package is currently only supported on Android devices.
3131
## Required Permissions on Android
3232

3333
In order to read and write outside the app-specific directories, additional
34-
permissions will be required. These must be enabled on the `AndroidManifest.xml`
35-
of your app located on `android/app/src/main`. More recent releases of `Android`
36-
are managing storage permissions on the [file's purpose](https://developer.android.com/training/data-storage#permissions) and therefore have no effect applied.
34+
permissions must be granted. These must be enabled on the `AndroidManifest.xml`
35+
of your app located on `android/app/src/main`.
3736

3837
```xml
3938
// Android devices prior to Android 11
4039
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
4140
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
42-
// Android devices from Android 11
41+
// Optional on Android devices from Android 11
4342
<uses-permission android:name="android.permission.MANAGE_EXTERNAL_STORAGE" />
4443
```
44+
Enabling the required permissions will be done using the `BackupStorage`'s
45+
`requestPermissions()` method, which utilizes the `permission_handler` package.
4546

46-
In order to access already existing backup files (the currently running app won't be able to access them directly), these permissions must first be granted.
47-
This will be done using the `BackupStorage`'s `requestPermissions()` method,
48-
which uses the `permission_handler` package.
47+
More recent releases of `Android`
48+
are managing storage permissions on the [file's purpose](https://developer.android.com/training/data-storage#permissions) and have some restrictions. In order to access already existing backup files created using previous installations
49+
on Android 10 and higher, the `MANAGE_EXTERNAL_STORAGE` permissions must be granted.
50+
The current installation won't be able to access them directly due to the altered
51+
file privileges. This must be specified on the `BackupStorage`'s `useManageExternalStoragePermission`
52+
flag. This practice is discouraged. Use the `BackupStorage`'s `pickBackupFile()`
53+
methods to allow picking a specific file without the need of additional permissions.
4954

50-
## Backup location
55+
## Backup Location
5156

5257
Backups are stored on the device's Media directories by default. But custom file
5358
paths are supported. The Media directories will include the Documents folder
5459
(default) on `/storage/emulated/0/Documents/` or the Download folder on
55-
`/storage/emulated/0/Download/`.
60+
`/storage/emulated/0/Download/`.
5661

5762
We recommend to use the Documents folder
5863
as backup location if possible for better security.
@@ -79,10 +84,11 @@ experiment with the app.
7984

8085
## Dependencies
8186

82-
Leitmotif uses the following Dart dependencies in order to implement certain
87+
LitBackupService uses the following Dart dependencies in order to implement certain
8388
features and functionality:
8489

8590
- [permission_handler](https://pub.dev/packages/permission_handler) - [License](https://github.com/Baseflow/flutter-permission-handler/blob/master/LICENSE) (Used to request storage access permissions)
91+
- [file_picker](https://pub.dev/packages/file_picker) - [License](https://github.com/miguelpruivo/flutter_file_picker/blob/master/LICENSE) (Used to allow platform-specific file picking)
8692

8793
## Credits
8894

@@ -93,8 +99,8 @@ LitBackupService is made possible thanks to the Flutter Project.
9399
Everything else in this repository including the source code is distributed under the
94100
**BSD 3-Clause** license as specified in the `LICENSE` file.
95101

96-
[screenshot_1]: assets/screenshots/LitBackupService_Screenshot_1.png
97-
[screenshot_2]: assets/screenshots/LitBackupService_Screenshot_2.png
102+
[screenshot_1]: assets/screenshots/Screenshot_1.png
103+
[screenshot_2]: assets/screenshots/Screenshot_2.png
98104
[lit_backup_service]: https://pub.dev/packages/lit_backup_service
99105
[lit_backup_service_pub_points]: https://pub.dev/packages/lit_backup_service/score
100106
[lit_backup_service_badge_pub]: https://img.shields.io/pub/v/lit_backup_service.svg
Binary file not shown.
Binary file not shown.

assets/screenshots/Screenshot_1.png

70.6 KB
Loading

assets/screenshots/Screenshot_2.png

116 KB
Loading

0 commit comments

Comments
 (0)