summaryrefslogtreecommitdiffstats
path: root/mobile/android/android-components/components/lib/fetch-httpurlconnection/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'mobile/android/android-components/components/lib/fetch-httpurlconnection/README.md')
-rw-r--r--mobile/android/android-components/components/lib/fetch-httpurlconnection/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/mobile/android/android-components/components/lib/fetch-httpurlconnection/README.md b/mobile/android/android-components/components/lib/fetch-httpurlconnection/README.md
new file mode 100644
index 0000000000..21ed90d434
--- /dev/null
+++ b/mobile/android/android-components/components/lib/fetch-httpurlconnection/README.md
@@ -0,0 +1,25 @@
+# [Android Components](../../../README.md) > Libraries > Fetch-HttpURLConnection
+
+A [concept-fetch](../../concept/fetch/README.md) implementation using [HttpURLConnection](https://developer.android.com/reference/java/net/HttpURLConnection.html).
+
+This implementation of `concept-fetch` uses [HttpURLConnection](https://developer.android.com/reference/java/net/HttpURLConnection.html) from the standard library of the Android System. Therefore this component has no third-party dependencies and is smaller than other implementations. It's intended use is for apps that have strict APK size constraints.
+
+## 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:lib-fetch-httpurlconnection:{latest-version}"
+```
+
+### Performing requests
+
+See the [concept-fetch documentation](../../concept/fetch/README.md) for generic examples of using the API of components implementing `concept-fetch`.
+
+## 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/