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

[Tweaks] DocC documentation #15

Merged
javier merged 7 commits from tweaks/docc into main 2023-04-25 14:29:24 +00:00
Conversation 0 Commits 7 Files Changed 169 +45 -43
4 changed files with 45 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 0671c05238 - Show all commits

28
Package.resolved
View File

@ -1,32 +1,34 @@
{
"object": {
"pins": [
{
"identity" : "swift-docc-plugin",
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-docc-plugin",
"package": "SwiftDocCPlugin",
"repositoryURL": "https://github.com/apple/swift-docc-plugin",
"state": {
"branch": null,
"revision": "9b1258905c21fc1b97bf03d1b4ca12c4ec4e5fda",
"version": "1.2.0"
}
},
{
"identity" : "swift-docc-symbolkit",
"kind" : "remoteSourceControl",
"location" : "https://github.com/apple/swift-docc-symbolkit",
"package": "SymbolKit",
"repositoryURL": "https://github.com/apple/swift-docc-symbolkit",
"state": {
"branch": null,
"revision": "b45d1f2ed151d057b54504d653e0da5552844e34",
"version": "1.0.0"
}
},
{
"identity" : "swift-libs",
"kind" : "remoteSourceControl",
"location" : "https://github.com/rock-n-code/swift-libs.git",
"package": "SwiftLibs",
"repositoryURL": "https://github.com/rock-n-code/swift-libs.git",
"state": {
"revision" : "2ba3e33a0e8c0ffc2b69efa906b03364a9d53a51",
"version" : "0.1.2"
"branch": null,
"revision": "4a1fab2f8a758a53376102bae14981f97540cab2",
"version": "0.1.3"
}
}
],
"version" : 2
]
},
"version": 1
}

6
Package.swift
View File

@ -14,9 +14,9 @@ import PackageDescription
let package = Package(
name: "AmiiboService",
platforms: [
.iOS(.v13),
.macOS(.v10_15),
.tvOS(.v13),
.iOS(.v15),
.macOS(.v12),
.tvOS(.v15),
.watchOS(.v8)
],
products: [

12
README.md
View File

@ -14,9 +14,9 @@ Ready-to-use service that retrieves data as decoded models from any of the [Amii
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*;
* *iOS 15.0 or higher*;
* *macOS 12.0 or higher*;
* *tvOS 15.0 or higher*;
* *watchOS 8.0 or higher*.
### Package file
@ -26,7 +26,7 @@ In the intended `Package.swift` file, it is required to add the following depend
```swift
dependencies: [
// ...
.package(url: "https://github.com/rock-n-code/amiibo-service.git", from: "1.0.0")
.package(url: "https://github.com/rock-n-code/amiibo-service.git", from: "1.0.1")
// ...
],
```
@ -55,7 +55,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;
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);
7. define the dependency rule (the *Up to Next Major Version* option and the *1.0.1* 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. now you should be ready to start using this package!
@ -64,7 +64,7 @@ In an opened Xcode project, it is required to follow these steps to install the
This library is fully supported on Apple platforms only for the time being: *iOS*, *macOS*, *tvOS*, and *watchOS*. Support for other platforms such as *Linux* or *Windows* might be added in the future, depending on the type of changes those platforms require but this needs to be researched first.
⚠️ 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.
⚠️ 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* has not been prioritised.
## Further documentation

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

@ -7,9 +7,9 @@ Install the package and start using the service to retrieve any available data f
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.
It is also important to highlight that this package has minimum platform requirements that must be taken into account:
* *iOS 13.0 or higher*;
* *macOS 10.15 or higher*;
* *tvOS 13.0 or higher*;
* *iOS 15.0 or higher*;
* *macOS 12.0 or higher*;
* *tvOS 15.0 or higher*;
* *watchOS 8.0 or higher*.
### The "Package.swift" file way
@ -19,7 +19,7 @@ In the intended `Package.swift` file, it is required to add the dependency, as d
```swift
dependencies: [
// ...
.package(url: "https://github.com/rock-n-code/amiibo-service.git", from: "1.0.0")
.package(url: "https://github.com/rock-n-code/amiibo-service.git", from: "1.0.1")
// ...
],
```
@ -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;
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);
7. define the dependency rule (the *Up to Next Major Version* option and the *1.0.1* 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. now you should be ready to start using this package!