javier
d5bd9feb0a
This PR contains the work done to write the main article of the `DocC` documentation for the library, which introduces the library as well as explains how to install it and use it. Reviewed-on: #7 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
Marvel Service
A library written entirely with Swift that allow the developer to interacts with the Marvel API backend service.
Installation
To use this library with your package, then add it as a dependency in the Package.swift file:
let package = Package(
// name, platforms, products, etc.
dependencies: [
.package(url: "https://github.com/rock-n-code/marvel-service", from: "1.0.0"),
// other dependencies
],
targets: [
.target(
name: "SomeTarget",
dependencies: [
.product(name: "MarvelService", package: "marvel-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.10 or higher is required in order to compile this library.
Documentation
Please refer to the online documentation for further informations about this library.