summaryrefslogtreecommitdiffstats
path: root/mobile/android/android-components/components/concept/sync/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'mobile/android/android-components/components/concept/sync/README.md')
-rw-r--r--mobile/android/android-components/components/concept/sync/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/mobile/android/android-components/components/concept/sync/README.md b/mobile/android/android-components/components/concept/sync/README.md
new file mode 100644
index 0000000000..787a6a3af2
--- /dev/null
+++ b/mobile/android/android-components/components/concept/sync/README.md
@@ -0,0 +1,26 @@
+# [Android Components](../../../README.md) > Concept > Sync
+
+The `concept-sync` component contains interfaces and types that describe various aspects of data synchronization.
+
+This abstraction makes it possible to create different implementations of synchronization backends, without tightly
+coupling concrete implementations of storage, accounts and sync sub-systems.
+
+## Usage
+
+### Setting up the dependency
+
+Use Gradle to download the library from [maven.mozilla.org](https://maven.mozilla.org/) ([Setup repository](../../../README.md#maven-repository)):
+
+```Groovy
+implementation "org.mozilla.components:concept-sync:{latest-version}"
+```
+
+### Integration
+
+TODO
+
+## License
+
+ This Source Code Form is subject to the terms of the Mozilla Public
+ License, v. 2.0. If a copy of the MPL was not distributed with this
+ file, You can obtain one at http://mozilla.org/MPL/2.0/