diff --git a/README.md b/README.md index 886e01644..16a49ba89 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ To use this library, then add it as a dependency in the `Package.swift` file of let package = Package( // name, platforms, products, etc. dependencies: [ - .package(url: "https://github.com/rock-n-code/discogs-service", from: "0.3.0"), + .package(url: "https://github.com/rock-n-code/discogs-service", from: "0.6.1"), // other dependencies ], targets: [ diff --git a/Sources/DiscogsService/Catalogs/DiscogsService.docc/Library.md b/Sources/DiscogsService/Catalogs/DiscogsService.docc/Library.md index d1df13773..ab851b2f7 100644 --- a/Sources/DiscogsService/Catalogs/DiscogsService.docc/Library.md +++ b/Sources/DiscogsService/Catalogs/DiscogsService.docc/Library.md @@ -6,6 +6,33 @@ A Swift client library for the Discogs API, built on top of Swift OpenAPI. This library provides a type-safe client for interacting with the [Discogs API](https://www.discogs.com/developers), including endpoints for the database, user identity, user collections, wantlists, lists, and the marketplace. It supports multiple authentication methods and transports credentials via headers or query parameters. +## 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.6.1"), + // 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. + ## Topics ### Clients