summaryrefslogtreecommitdiffstats
path: root/mobile/android/android-components/components/concept/push/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'mobile/android/android-components/components/concept/push/README.md')
-rw-r--r--mobile/android/android-components/components/concept/push/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/mobile/android/android-components/components/concept/push/README.md b/mobile/android/android-components/components/concept/push/README.md
new file mode 100644
index 0000000000..dd596fdc78
--- /dev/null
+++ b/mobile/android/android-components/components/concept/push/README.md
@@ -0,0 +1,23 @@
+# [Android Components](../../../README.md) > Concept > Push
+
+An abstract definition of a push service component.
+
+## Usage
+
+### Setting up the dependency
+
+Use Gradle to download the library from [maven.mozilla.org](https://maven.mozilla.org/) ([Setup repository](../../../README.md)):
+
+```Groovy
+implementation "org.mozilla.components:concept-push:{latest-version}"
+```
+
+### Implementing a Push service.
+
+TBD
+
+## 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/