Skip to content

Commit

Permalink
Added Contributing section. Added links to QA and Issues.
Browse files Browse the repository at this point in the history
  • Loading branch information
RobertoMachorro committed Jul 22, 2023
1 parent 2663ad2 commit 7a501f7
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ A Swift library for Gravatar Profile data access.

[Gravatar](https://gravatar.com) is a well known service for centralizing profiles and avatar images. This library allows applications to refer to Gravatar's data instead of reinventing the wheel.

# How to Use
Reach out in [Discussions](https://github.com/RobertoMachorro/SwiftGravatar/discussions) if you have any questions. Report bugs to [Issues](https://github.com/RobertoMachorro/SwiftGravatar/issues).

# Using

Add the SwiftGravatar package to your project or via Package.swift using the address:

Expand Down Expand Up @@ -48,3 +50,9 @@ An easy converter from e-mail to Gravatar URL can be accessed as follows:
let myemailaddress = GravatarProfile.getProfileAddress(using: "[email protected]")
// "https://en.gravatar.com/0bc83cb571cd1c50ba6f3e8a78ef1346.json"
```

# Contributing

Contributions are very welcome. Fork the repo, make your changes, test with SwiftLint and Unit tests, commit and do a *pull request*.

Gravatar doesn't have an official spec of the JSON data, so there is a lot of trial and error here.

0 comments on commit 7a501f7

Please sign in to comment.