From 599429d63d150877b1d61dea4cb9e75dae150b56 Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Tue, 25 Apr 2023 00:40:24 +0200 Subject: [PATCH] Updated the text of the README file. --- README.md | 27 +++++++++++---------------- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index fe1682d..d1210ab 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,13 @@ Ready-to-use service that retrieves data as decoded models from any of the [Amii ## Installation -It is possible to add this library in your projects either by explicitly add it as a dependency either in a `Package.swift` file or in your Xcode project. +It is possible to add this package to other libraries and applications by adding it as a dependency in a `Package.swift` file or in a Xcode project, through the *Package dependencies* interface. This package has minimum platform requirements that are important to take into account: * *iOS 13.0 or higher*; * *macOS 10.15 or higher*; * *tvOS 13.0 or higher*; -* *watchOS 8.0 or higher*; +* *watchOS 8.0 or higher*. ### Package file @@ -47,17 +47,18 @@ targets: [ ### Xcode -In an opened Xcode project, it is required to do these steps: -1. click on your Xcode project file to display *Project* and *Targets*; -2. select the project under the *Project* section to show the *Info*, *Build Settings* and *Package Dependencies* in the center menu of the screen; -3. select the *Package Dependencies* to show the defined dependencies of the project; +In an opened Xcode project, it is required to follow these steps to install the package: + +1. click on the Xcode project file in the sidebar to display *Project* and *Targets*; +2. select the project under the *Project* section to show the *Info*, *Build Settings* and *Package Dependencies* options in the center menu just right on top; +3. select the *Package Dependencies* option to show the defined dependencies of the project; 4. press on the *+* (plus) button to add dependencies to the project; -5. enter the URL`https://github.com/rock-n-code/amiibo-service` into the *Search or Enter Package URL* located in the upper right corner; -6. select the given option; +5. enter the URL `https://github.com/rock-n-code/amiibo-service` into the *Search or Enter Package URL* located in the upper right corner; +6. select the retrieved option; 7. define the dependency rule (the *Up to Next Major Version* option and the *1.0.0* text are recommended); 8. select the target to which the dependency will be applied (if required); 9. wait for the package to be resolved and included in the project; -10. done! +10. now you should be ready to start using this package! ### Other considerations @@ -65,14 +66,8 @@ This library is fully supported on Apple platforms only for the time being: *iOS ⚠️ Please notice that this library only supports the [Swift Package Manager](https://www.swift.org/package-manager/), and that support for other dependency managers such as *Cocoapods* and *Carthage* is not planned. -## Usage - -This package provides an actor called `AmiiboService` which, after is initialised, is responsible for making requests based on a given filter criteria to the remote API, handling the responses, and decoding the retrieved data into models/entities structs, or throws errors if necessary. - -It is needless to say, all the necessary filters, models/entities, and enumerations are also provided in this package. - ## Further documentation -For further information about this package, please refer to the [AmiiboService documentation](https://rock-n-code.github.io/amiibo-service/documentation/amiiboservice/) available online. +For further information about how to use this service or reference documentation about any of its components, please refer to the [AmiiboService documentation](https://rock-n-code.github.io/amiibo-service/documentation/amiiboservice/) available online. For further information about the API, please refer to the [Amiibo API documentation](https://www.amiiboapi.com/docs/) available online.