From 7790bfa6d3ceeff9a412d83c8b50f9b78b627dbf Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Tue, 9 Sep 2025 20:54:24 +0200 Subject: [PATCH] Fixed some documentation issues encountered in the Library article of the DocC documentation catalog. --- Catalogs/AmiiboService.docc/Library.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/Catalogs/AmiiboService.docc/Library.md b/Catalogs/AmiiboService.docc/Library.md index 9b1d86d..35d7ae7 100644 --- a/Catalogs/AmiiboService.docc/Library.md +++ b/Catalogs/AmiiboService.docc/Library.md @@ -4,13 +4,13 @@ A library that provides everything the developer needs to interacts with the **A ## 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 -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: @@ -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. +## 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 ### Service