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

Updated the AmiiboService and GettingStarted documentation pages.

Browse Source
This commit is contained in:
Javier Cicchelli 2023-04-30 15:52:49 +02:00
parent f2821e458b
commit d5b665a4f9
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Sources/AmiiboService.docc/AmiiboService.md
View File

@ -4,7 +4,7 @@ Ready-to-use service that retrieves decoded entities from any of the [Amiibo API
## Overview ## Overview
**AmiiboService** provides a service, filters and models for retrieving data from the remote [Amiibo API](https://www.amiiboapi.com) endpoints to use in libraries and applications targeting Apple platforms, such as *iOS*, *macOS*, *tvOS*, and *watchOS*. This package provides structures that can be used to include filters to the requests to send to the remote service if required. In addition, the structures to model the kinds of data coming in from those responses into entities are also provided. **AmiiboService** provides a service, filters and models for retrieving data from the remote [Amiibo API](https://www.amiiboapi.com) endpoints to use in libraries and applications targeting not only Apple platforms, such as *iOS*, *macOS*, *tvOS*, and *watchOS*, but also *Linux*. This package provides structures that can be used to include filters to the requests to send to the remote service if required. In addition, the structures to model the kinds of data coming in from those responses into entities are also provided.
## Topics ## Topics

4
Sources/AmiiboService.docc/GettingStarted.md
View File

@ -19,7 +19,7 @@ In the intended `Package.swift` file, it is required to add the dependency, as d
```swift ```swift
dependencies: [ dependencies: [
// ... // ...
.package(url: "https://github.com/rock-n-code/amiibo-service.git", from: "1.0.2") .package(url: "https://github.com/rock-n-code/amiibo-service.git", from: "1.0.3")
// ... // ...
], ],
``` ```
@ -48,7 +48,7 @@ In an opened Xcode project, it is required to follow these steps to install the
4. press on the *+* (plus) button to add dependencies to 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; 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; 6. select the retrieved option;
7. define the dependency rule (the *Up to Next Major Version* option and the *1.0.2* text are recommended); 7. define the dependency rule (the *Up to Next Major Version* option and the *1.0.3* text are recommended);
8. select the target to which the dependency will be applied (if required); 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; 9. wait for the package to be resolved and included in the project;
10. now you should be ready to start using this package! 10. now you should be ready to start using this package!