This PR contains the work done to encapsulate the public models under a namespace, to avoid any possible ambiguities when developers use this package. Furthermore, some documentation has been updated an, of course, the available Xcode and Web documentation has been re-generated.
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Reviewed-on: #19
This PR contains the work done to update the package dependencies to their latest version. In addition, the Xcode and the Web documentation has been re-generated.
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Reviewed-on: #18
This PR contains the work done to provide full support of this package to Linux platform, by removing the restriction on the `AmiiboClient` client and the `AmiiboService` service put in place on the `v1.0.1` release.
To provide further details about the work done:
- [x] updated the `SwiftLibs` package dependency to `v0.1.7`;
- [x] made the `AmiiboClient` client and the `AmiiboService` service available to Linux platforms by importing the `FoundationNetworking` framework when available;
- [x] updated the content of some DocC documentation pages;
- [x] regenerated the Xcode and Github pages documentation;
- [x] updated some text in the `README` file.
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Reviewed-on: #17
This PR contains the work done to provide basic Linux support to this package.
To provide further details about the work done:
- [x] updated the `SwiftLibs` dependency to `v0.1.5`;
- [x] updated the Swift tools version in the `Package` file to `v5.7`;
- [x] added the `/.vscode` folder to the `.gitignore` file;
- [x] filtered out the `AmiiboClient` and `AmiiboService` entities from Linux platforms;
- [x] added several targets to the `Makefile` to smooth several development work-flows;
- [x] updated the Xcode and Github pages documentation.
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Reviewed-on: #16
This PR contains the work done to address the issue #14, that recommends some tweaks to the generated documentation targeting Xcode and Github pages.
To provide further details about the work done:
- [x] written the *Getting Started* article in the documentation catalog;
- [x] written the *AmiiboService* article in the documentation catalog;
- [x] updated the text of the `README` file;
- [x] downgraded the Swift tool version in the `Package` file to v5.5;
- [x] added the missing header file to the `Package` file;
- [x] updated the `SwiftLibs` package dependency to its latest release;
- [x] re-generated the documentation targeting Xcode and Github pages.
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Reviewed-on: #15
This PR contains the work done to address the issue #11, related to setting up DocC documentation in this project.
To provide further details about the work done:
- [x] created the documentation catalog for the project in Xcode;
- [x] added the `Swift-DocC-Plugin` dependency to the `Package` file;
- [x] implemented documentation preview, generation and cleanup workflows in the `Makefile` file;
- [x] generated documentation for Xcode and Github pages;
- [x] added the package logo assets to the project;
- [x] integrated the package logo assets to the `README` file, with support for both light and dark color schemes;
- [x] added the `.env` file to the `.gitignore` file.
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Reviewed-on: #13
