rock-n-code/amiibo-service
1
0
Fork 0
Code Issues Pull Requests Actions Releases 15 Activity

DocC documentation content fixes. #6

Merged
javier merged 3 commits from documentation/fixes into main 2025-09-09 18:58:19 +00:00
Conversation 0 Commits 3 Files Changed 117
+12 -4
1 changed files with 12 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 7790bfa6d3 - Show all commits
Catalogs/AmiiboService.docc/Library.md
+12 -4
View File
@@ -4,13 +4,13 @@ A library that provides everything the developer needs to interacts with the **A
## Overview ## Overview
The `AmiiboService` library is a Swift Package Manager package dependency aims at allowing the developer to interact with the [Amiibo API](https://www.amiiboapi.com) online service seamlessly, by not only providing the *service* tye but also any possible *clients*, *models*, *filters* and *errors* type that might be needed. The `AmiiboService` library is a Swift Package Manager package dependency aims at allowing the developer to interact with the [Amiibo API](https://www.amiiboapi.com) backend service seamlessly, by not only providing the *service* type but also any possible *clients*, *models*, *filters* and *errors* types that might be needed during implementation.
## Design ## Design
Although it could have been possible to generate a one-to-one RESTful client based on the Open API specification document that describe the available endpoints at the backend, it was decided to design a ``AmiiboService`` service that removes the complexities of the backend service's API design, and provides the developer with a simple interface, and a seamless experience. Although it could have been possible to generate a one-to-one RESTful client based on the Open API specification document that describe the available endpoints of the backend service, it was decided to design a `AmiiboService` service type that removes the complexities of the API design imposed by the backend service, and provides the developer with a simple interface, and a seamless experience.
## Instalation ## Installation
To use the `AmiiboService` library with your package, then add it as a dependency in the `Package.swift` file: To use the `AmiiboService` library with your package, then add it as a dependency in the `Package.swift` file:
@@ -33,10 +33,18 @@ let package = Package(
) )
``` ```
It is also possible to use the `AmiiboService` library with your app in Xcode, then add it as a dependency in your Xcode project: It is also possible to use the `AmiiboService` 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. > important: Swift 5.9 or higher is required in order to compile this library.
## Tasks
This library offers a set of ready-to-use project management tasks that the developer could use from the command line. To show the list of tasks on the `Terminal` app, plus display some explanations about each and every one of them; please enter the following command:
```bash
$ make
```
## Topics ## Topics
### Service ### Service