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

Updated the documentation at the README file in the project.

Browse Source
This commit is contained in:
javier
2026-07-26 10:31:29 +02:00
parent 522f48e5a2
commit fb95989d83
1 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+12 -2
View File
@@ -31,7 +31,7 @@ let package = Package(
It is also possible to use this library with your app in Xcode by adding it as a dependency in your Xcode project.
> [!IMPORTANT]
> Swift 5.10 or higher is required in order to build this library.
> Swift 6.2 or higher is required in order to build this library.
## Usage
@@ -83,7 +83,7 @@ let service = AmiiboService(
## Testing
The `AmiiboClient` protocol enables creating custom mock clients for unit testing without network calls. Conform to `AmiiboClient` and inject it into `AmiiboService` via its `init(client:)` initializer:
The `AmiiboClient` protocol enables creating custom mock clients for unit testing without network calls. Conform to `AmiiboClient` and inject it into `AmiiboService` via its `init(client:)` initializer. Since `AmiiboClient` refines `Sendable`, conforming types must be safe to share across concurrency domains:
```swift
import AmiiboService
@@ -104,6 +104,16 @@ struct MyMockClient: AmiiboClient {
let service = AmiiboService(client: MyMockClient())
```
### Running the test suite
The unit tests based on a mock client run offline by default. The tests against the live service are skipped unless the `AMIIBO_LIVE_TESTS` environment variable is set to `1`, either in the environment when testing from the command line:
```shell
AMIIBO_LIVE_TESTS=1 swift test
```
or in the `Test` action of the scheme when testing from Xcode.
## Documentation
Please refer to the [online documentation](https://rock-n-code.github.io/amiibo-service/documentation/amiiboservice/) for further information about this library.