javier
bc0ae63719
This PR contains the work done to: * Updated the library *DocC* documentation catalog; * Updated the library documentation for both *Xcode* and *GitHub Pages*; * Added the Swift version and compatibility badges to the README file; * Added the link to the *GitHub Pages* documentation in the *Swift Package Index* configuration. Reviewed-on: #13 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
38 lines
1.5 KiB
Markdown
38 lines
1.5 KiB
Markdown
# Amiibo Service
|
|
|
|
[](https://swiftpackageindex.com/rock-n-code/amiibo-service)
|
|
[](https://swiftpackageindex.com/rock-n-code/amiibo-service)
|
|
|
|
A library written entirely with [Swift](https://www.swift.org) that provides everything the developer needs to interacts with the [Amiibo API](https://www.amiiboapi.com) backend service.
|
|
|
|
## Installation
|
|
|
|
To use this library with your package, then add it as a dependency in the `Package.swift` file:
|
|
|
|
```swift
|
|
let package = Package(
|
|
// name, platforms, products, etc.
|
|
dependencies: [
|
|
.package(url: "https://github.com/rock-n-code/amiibo-service", from: "1.0.0"),
|
|
// other dependencies
|
|
],
|
|
targets: [
|
|
.target(
|
|
name: "SomeTarget",
|
|
dependencies: [
|
|
.product(name: "AmiiboService", package: "amiibo-service"),
|
|
]
|
|
)
|
|
// other targets
|
|
]
|
|
)
|
|
```
|
|
|
|
It is also possible to use this library with your app in Xcode, then add it as a dependency in your Xcode project.
|
|
|
|
> important: Swift 5.9 or higher is required in order to compile this library.
|
|
|
|
## Documentation
|
|
|
|
Please refer to the [online documentation](https://rock-n-code.github.io/amiibo-service/documentation/amiiboservice/) for further informations about this library.
|