dnrops
/
CSFloatKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README code syntax highlight

This commit is contained in:
Tomás Martins 2021-11-13 19:21:43 -03:00 committed by GitHub
parent e8fb95c850
commit 7e48450ed2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -10,9 +10,9 @@ If you're running Xcode 11 or later, you can simply go to `File -> Swift Package
If you're running an earlier version, you'll have to set up SPM on your project and add the following dependency to your `Package.swift` file: If you're running an earlier version, you'll have to set up SPM on your project and add the following dependency to your `Package.swift` file:
``` ```swift
dependencies: [ dependencies: [
.package(url: "https://github.com/tfmart/CSFloatKit.git", from: "0.1.0") .package(url: "https://github.com/tfmart/CSFloatKit.git", from: "0.1.0")
] ]
``` ```
@ -22,13 +22,13 @@ To get started, you will need to create an instance of `CSFloatConfiguration` an
* Initiating with an inspect link * Initiating with an inspect link
``` ```swift
let configuration = CSFloatConfiguration(inspectLink: "steam://rungame/730/76561202255233023/+csgo_econ_action_preview%20S76561198084749846A698323590D7935523998312483177") let configuration = CSFloatConfiguration(inspectLink: "steam://rungame/730/76561202255233023/+csgo_econ_action_preview%20S76561198084749846A698323590D7935523998312483177")
``` ```
* Initiating with the S, A, D, M parameters * Initiating with the S, A, D, M parameters
``` ```swift
let configuration = CSFloatConfiguration(inventoryParameter: nil, let configuration = CSFloatConfiguration(inventoryParameter: nil,
assetParameter: "13874827217", assetParameter: "13874827217",
dParameter: "4649025583329100061", dParameter: "4649025583329100061",
@ -37,7 +37,7 @@ let configuration = CSFloatConfiguration(inventoryParameter: nil,
After the setting up the configuration, create an instance of `SWGORequester` to create a float request After the setting up the configuration, create an instance of `SWGORequester` to create a float request
``` ```swift
let request = CSFloatRequester(configuration: config) { (skin, error) in let request = CSFloatRequester(configuration: config) { (skin, error) in
} }
@ -45,7 +45,7 @@ let request = CSFloatRequester(configuration: config) { (skin, error) in
And to start the request: And to start the request:
``` ```swift
request.start() request.start()
``` ```
@ -55,7 +55,7 @@ The request will either the skin fetched from the inspect link or a `ApiError`,
After fetching an instance of `Skin` with the requester, you can use the `getScreenshotURL()` method to get an URL string which can be used to get a screenshot image, by using the [CS.Deals' csgo.gallery screenshot service](https://cs.deals/pt/screenshot) After fetching an instance of `Skin` with the requester, you can use the `getScreenshotURL()` method to get an URL string which can be used to get a screenshot image, by using the [CS.Deals' csgo.gallery screenshot service](https://cs.deals/pt/screenshot)
``` ```swift
let configuration = CSFloatConfiguration(inspectLink: "steam://rungame/730/76561202255233023/+csgo_econ_action_preview%20S76561198084749846A698323590D7935523998312483177") let configuration = CSFloatConfiguration(inspectLink: "steam://rungame/730/76561202255233023/+csgo_econ_action_preview%20S76561198084749846A698323590D7935523998312483177")
let request = SWGORequester(configuration: config) { (skin, error) in let request = SWGORequester(configuration: config) { (skin, error) in
let screenshotURL = skin.getScreenshotURL() let screenshotURL = skin.getScreenshotURL()
@ -66,7 +66,7 @@ request.start()
From version 0.3 upwards, it's also possible to fetch [CS.Money](https://cs.money) screenshots and 3D models, just by using the item's inspect link or an instance of a `Skin` object: From version 0.3 upwards, it's also possible to fetch [CS.Money](https://cs.money) screenshots and 3D models, just by using the item's inspect link or an instance of a `Skin` object:
``` ```swift
let configuration = CSMConfiguration(inspectLink: "steam://rungame/730/76561202255233023/+csgo_econ_action_preview%20S76561199043158336A20517916623D14133434752320963923") let configuration = CSMConfiguration(inspectLink: "steam://rungame/730/76561202255233023/+csgo_econ_action_preview%20S76561199043158336A20517916623D14133434752320963923")
let request = CSMRequester(configuration: config, completion: { (fetchedScreenshot, error) in let request = CSMRequester(configuration: config, completion: { (fetchedScreenshot, error) in
// URL for the skin's screenshot // URL for the skin's screenshot