diff options
Diffstat (limited to 'mobile/android/android-components/components/lib/fetch-okhttp/README.md')
| -rw-r--r-- | mobile/android/android-components/components/lib/fetch-okhttp/README.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/mobile/android/android-components/components/lib/fetch-okhttp/README.md b/mobile/android/android-components/components/lib/fetch-okhttp/README.md new file mode 100644 index 0000000000..d1cd0a3d2f --- /dev/null +++ b/mobile/android/android-components/components/lib/fetch-okhttp/README.md @@ -0,0 +1,25 @@ +# [Android Components](../../../README.md) > Libraries > Fetch-OkHttp + +A [concept-fetch](../../concept/fetch/README.md) implementation using [OkHttp](https://github.com/square/okhttp). + +This implementation of `concept-fetch` uses [OkHttp](https://github.com/square/okhttp) - a third-party library from Square. It is intended for apps that already use OkHttp and want components to use the same client. + +## 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-okhttp:{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/ |