Skip to content

Commit 8495f4b

Browse files
committed
Updated README to provide more details about registering with TheCatAPI
1 parent 37d0172 commit 8495f4b

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
[![License](http://img.shields.io/badge/License-MIT-green.svg?style=flat)](https://github.com/wibosco/BackgroundTransferRevised-Example/blob/main/LICENSE)
44

55
# BackgroundTransferRevised-Example
6-
An example project showing how we can use a background URLSession to keep downloads going even when the app is terminated.
6+
An example project showing how to use a background URLSession to keep downloads going even when the app is terminated.
77

8-
In order to run this project, you will need to register with [TheCatAPI](https://thecatapi.com/) to get a `x-api-key` token to access TheCatAPI's API (which the project uses to get its example content). Once you have your `x-api-key`, add it to the proj$
8+
This project uses [TheCatAPI](https://thecatapi.com/) to populate the app with downloaded images. `TheCatAPI` has an extensive library of freely available cat photos which it shares via a JSON-based API. While free to use, `TheCatAPI` does require you to [register](https://thecatapi.com/signup) to get full access to it's API (limited access is provided without an API key). Once registered you will be given an `x-api-key` token which you can paste as the `APIKey` value in `NetworkService` so that it is sent with each network request.
99

10+
If you have any trouble getting the project to run, please create an issue.

0 commit comments

Comments
 (0)