From 801dcc42ede4d1c5349186544ff9705dd150b851 Mon Sep 17 00:00:00 2001 From: Torsten Grote Date: Fri, 5 Mar 2021 14:05:04 -0300 Subject: [PATCH] add READMEs and tie them together in main README --- README.md | 6 ++++++ storage/README.md | 10 ++++++++++ storage/doc/design.md | 2 +- 3 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 storage/README.md diff --git a/README.md b/README.md index 20c0018a..5e3f347e 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,12 @@ A backup application for the [Android Open Source Project](https://source.android.com/). +## Components + +* [Local Contacts Backup](contactsbackup) - an app that backs up local on-device contacts +* [Storage library](storage) - a library handling efficient backup of files +* [Seedvault app](app) - the main app where all functionality comes together + ## Features - Backup application data to a flash drive. - Restore application data from a flash drive. diff --git a/storage/README.md b/storage/README.md new file mode 100644 index 00000000..56f7260c --- /dev/null +++ b/storage/README.md @@ -0,0 +1,10 @@ +# Seedvault Storage + +This is a library for Seedvault storage backup. +It can also be used by other apps wanting to provide storage backup feature. + +Please see the [design document](doc/design.md) for more information. + +There is also a [demo app](demo) that illustrates the working of the library +and does not need to be a system app with elevated permissions. +It can be built and installed as a regular app requesting permissions at runtime. diff --git a/storage/doc/design.md b/storage/doc/design.md index 0e0955a1..332bb571 100644 --- a/storage/doc/design.md +++ b/storage/doc/design.md @@ -1,6 +1,6 @@ # Overview -This is a design document for Seedvault Storage backup. +This is a design document for Seedvault storage backup. It is heavily inspired by borgbackup, but simplified and adapted to the Android context. The aim is to efficiently backup media files from Android's `MediaStore`