javier
410a200661
This PR contains the work done to: * Update the `Library` article in the DocC documentation catalog in the project; * Generate the DocC documentation of the library for GitHub Pages; * Written the `README` file in the project. Reviewed-on: #5 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
Amiibo Service
A library written entirely with Swift that provides everything the developer needs to interacts with the Amiibo API backend service.
Installation
To use this library with your package, then add it as a dependency in the Package.swift file:
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 for further details about this library.