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

GitHub Pages documentation support. (#5)

Browse Source 
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>
This commit was merged in pull request #5.
This commit is contained in:
Javier Cicchelli
2025-09-09 18:34:29 +00:00
committed by Javier Cicchelli
parent 37c0f3e322
commit 410a200661
277 changed files with 690 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Catalogs/AmiiboService.docc/Library.md
+2 -2
View File
@@ -1,6 +1,6 @@
# ``AmiiboService``
A library that provides everything the developer needs to interacts with the **Amiibo API** online service.
A library that provides everything the developer needs to interacts with the **Amiibo API** backend service.
## Overview
@@ -8,7 +8,7 @@ The `AmiiboService` library is a Swift Package Manager package dependency aims a
## 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, it was decided to design a ``AmiiboService`` service that removes the complexities of the service's backend API, 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 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.
## Instalation