add READMEs and tie them together in main README

This commit is contained in:
Torsten Grote 2021-03-05 14:05:04 -03:00 committed by Chirayu Desai
parent e77d5cad2c
commit 801dcc42ed
3 changed files with 17 additions and 1 deletions

View file

@ -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.

10
storage/README.md Normal file
View file

@ -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.

View file

@ -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`