From c3b390277664831cb8464b4dac996383bd33c4d0 Mon Sep 17 00:00:00 2001
From: Javier Cicchelli <javier@rock-n-code.com>
Date: Tue, 9 Sep 2025 20:30:27 +0200
Subject: [PATCH] Updated the README file in the project.

---
 Catalogs/AmiiboService.docc/Library.md |  4 +--
 README.md                              | 35 +++++++++++++++++++++++++-
 2 files changed, 36 insertions(+), 3 deletions(-)

diff --git a/Catalogs/AmiiboService.docc/Library.md b/Catalogs/AmiiboService.docc/Library.md
index 5c8c692..9b1d86d 100644
--- a/Catalogs/AmiiboService.docc/Library.md
+++ b/Catalogs/AmiiboService.docc/Library.md
@@ -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
 
diff --git a/README.md b/README.md
index 569f56a..5ab4774 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,34 @@
-#  Amiibo Service
+# Amiibo Service
+
+A library written entirely with [Swift](https://www.swift.org) that provides everything the developer needs to interacts with the [Amiibo API](https://www.amiiboapi.com) backend service.
+
+## Installation
+
+To use this 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 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](https://rock-n-code.github.io/rock-n-code/amiibo-service) for further details about this library.
\ No newline at end of file