Updated the README file in the project.
This commit is contained in:
@@ -1,6 +1,6 @@
|
|||||||
# ``AmiiboService``
|
# ``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
|
## Overview
|
||||||
|
|
||||||
@@ -8,7 +8,7 @@ The `AmiiboService` library is a Swift Package Manager package dependency aims a
|
|||||||
|
|
||||||
## Design
|
## 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
|
## Instalation
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
||||||
Reference in New Issue
Block a user