Skip to content

Commit

Permalink
Update README.md & Create FUNDING.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
Pepijn98 committed Nov 14, 2019
1 parent d96faa7 commit 5a731d2
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 1 deletion.
12 changes: 12 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# These are supported funding model platforms

github: [KurozeroPB]
patreon: Kurozero
open_collective: # Replace with a single Open Collective username
ko_fi: kurozero
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
custom: ['https://www.paypal.me/pvdbroek', 'https://donatebot.io/checkout/240059867744698368']
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,28 @@ Wrapper for the unofficial azur lane json api in Swift

## Install
Import the library into your Package.swift
`.package(url: "https://github.com/azurlane-api/azurlane-swift.git", .branch("master"))`
`.package(url: "https://github.com/azurlane-api/azurlane-swift.git", from: "<latest-tag>")`

## Example
```swift
import Foundation
import AzurLane

let azurlane = AzurLane()

azurlane.getShips(from: .RARITY, with: "Super Rare") { (result: Result<ShipsResponse, AzurLaneAPIError>) in
switch result {
case .failure(let error):
print(error)
case .success(let response):
for ship in response.ships {
print("[\(ship.id)]: (\(ship.name))")
}
}
}

RunLoop.main.run()
```

## Support
![discord](https://discordapp.com/api/v6/guilds/240059867744698368/widget.png?style=banner2)

0 comments on commit 5a731d2

Please sign in to comment.