From 64033aff114d03df866833c279ae2e79073e54f7 Mon Sep 17 00:00:00 2001
From: Javier Cicchelli <javier@rock-n-code.com>
Date: Tue, 9 Sep 2025 18:56:13 +0200
Subject: [PATCH] Written the Introduction article for the AmiiboService
 documentation catalog.

---
 Catalogs/AmiiboService.docc/AmiiboService.md | 13 ----
 Catalogs/AmiiboService.docc/Introduction.md  | 74 ++++++++++++++++++++
 2 files changed, 74 insertions(+), 13 deletions(-)
 delete mode 100644 Catalogs/AmiiboService.docc/AmiiboService.md
 create mode 100644 Catalogs/AmiiboService.docc/Introduction.md

diff --git a/Catalogs/AmiiboService.docc/AmiiboService.md b/Catalogs/AmiiboService.docc/AmiiboService.md
deleted file mode 100644
index 405b379..0000000
--- a/Catalogs/AmiiboService.docc/AmiiboService.md
+++ /dev/null
@@ -1,13 +0,0 @@
-# ``amiibo-service``
-
-<!--@START_MENU_TOKEN@-->Summary<!--@END_MENU_TOKEN@-->
-
-## Overview
-
-<!--@START_MENU_TOKEN@-->Text<!--@END_MENU_TOKEN@-->
-
-## Topics
-
-### <!--@START_MENU_TOKEN@-->Group<!--@END_MENU_TOKEN@-->
-
-- <!--@START_MENU_TOKEN@-->``Symbol``<!--@END_MENU_TOKEN@-->
diff --git a/Catalogs/AmiiboService.docc/Introduction.md b/Catalogs/AmiiboService.docc/Introduction.md
new file mode 100644
index 0000000..c387068
--- /dev/null
+++ b/Catalogs/AmiiboService.docc/Introduction.md
@@ -0,0 +1,74 @@
+# ``AmiiboService``
+
+A library that provides everything the developer needs to interacts with the **Amiibo API** online service.
+
+## 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.
+
+## Design
+
+Although it could have been possible to generate a one-to-one 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.
+
+## Instalation
+
+To use the `AmiiboService` 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 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.
+
+## Topics
+
+### Service
+
+- ``AmiiboService``
+
+### Clients
+
+- ``AmiiboClient``
+- ``AmiiboLiveClient``
+- ``AmiiboMockClient``
+
+### Models
+
+- ``Amiibo``
+- ``Amiibo/Game``
+- ``Amiibo/Platform``
+- ``Amiibo/Release``
+- ``Amiibo/Usage``
+- ``AmiiboSeries``
+- ``AmiiboType``
+- ``GameCharacter``
+- ``GameSeries``
+
+### Filters
+
+- ``AmiiboFilter``
+- ``AmiiboSeriesFilter``
+- ``AmiiboTypeFilter``
+- ``GameCharacterFilter``
+- ``GameSeriesFilter``
+
+### Errors
+
+- ``AmiiboServiceError``