Skip to content

Commit

Permalink
Update README.md (#275)
Browse files Browse the repository at this point in the history
- Adding an extra feature copied from [Gravatar docs portal](https://docs.gravatar.com/sdk/ios-sdk)
- Adding a section about creating an API Key, copied from [Gravatar docs portal](https://docs.gravatar.com/sdk/ios-sdk)
  • Loading branch information
etoledom authored Jun 6, 2024
1 parent a93cb3c commit 5087268
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,20 @@ Gravatar SDK is a Swift library that allows you to integrate [Gravatar](https://

## Features

- Display a profile view or an avatar through ready-to-use UI components.
- Avatar URL calculator based on email and several [query options](https://docs.gravatar.com/general/images/).
- Avatar downloading based on email or url.
- `UIImageView` extension to directly set the downloaded image.
- Built-in image cache(also the ability to inject your own cache).
- Built-in image cache (with the ability to inject your own cache).
- Avatar uploading to a [Gravatar](https://gravatar.com/) account.
- Gravatar profile fetching based on email.

## Installation

### Create an API key

Follow the steps in the [REST API documentation](https://docs.gravatar.com/api/profiles/rest-api/) to create a Gravatar API key. You can use some features without an API Key, but you’ll receive limited information, and stricter rate limits may apply, so we highly encourage you to create one in the [developer portal](https://gravatar.com/developers/).

For installation instructions and examples, see out [getting started](Sources/Gravatar/Gravatar.docc/GettingStarted.md) guide.

## Author
Expand Down

0 comments on commit 5087268

Please sign in to comment.