Written a first version of the README file.
This commit is contained in:
@@ -1 +1,37 @@
|
||||
[](https://swiftpackageindex.com/rock-n-code/discogs-service)
|
||||
[](https://swiftpackageindex.com/rock-n-code/discogs-service)
|
||||
|
||||
# Discogs Service
|
||||
|
||||
A library written entirely with [Swift](https://www.swift.org) that allow the developer to interact with the [Discogs API](https://www.discogs.com/developers/#) backend service.
|
||||
|
||||
## Installation
|
||||
|
||||
To use this library, then add it as a dependency in the `Package.swift` file of your project:
|
||||
|
||||
```swift
|
||||
let package = Package(
|
||||
// name, platforms, products, etc.
|
||||
dependencies: [
|
||||
.package(url: "https://github.com/rock-n-code/discogs-service", from: "0.2.0"),
|
||||
// other dependencies
|
||||
],
|
||||
targets: [
|
||||
.target(
|
||||
name: "SomeTarget",
|
||||
dependencies: [
|
||||
.product(name: "DiscogsService", package: "discogs-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](https://rock-n-code.github.io/discogs-service/documentation/discogsservice/) for further informations about this library.
|
||||
|
||||
Reference in New Issue
Block a user