✨ ScratchIt - API

This repository only serves the point of providing access to the method signatures of ScratchIt's Java API.
This repository does NOT contain the source code of ScratchIt, to test and use this, you will still require a copy of ScratchIt!

---

☕ Java documentation

---

📦 Packages

You can find an overview of all packages here:
https://github.com/LoneDev6/API-ScratchIt/packages/

Alternatively you can directly reference this library using Maven or Gradle by following the instructions outlined below.

Table of contents

• Developer reference (Maven)
  1. via jitpack.io
  2. via maven.pkg.github.com
• Developer reference (Gradle)
  1. via maven.pkg.github.com
  2. via jitpack.io

Developer reference (Maven)

To build your project against this library, simply include one of the following references in your pom.xml:

1. via jitpack.io

Add this to your <repositories> section:

<repository>
    <id>jitpack-repo</id>
    <url>https://jitpack.io</url>
</repository>

In your <dependencies> section (Replace VERSION with the latest release of this package):

<dependency>
    <groupId>com.github.LoneDev6</groupId>
    <artifactId>api-ScratchIt</artifactId>
    <version>VERSION</version>
    <scope>provided</scope>
</dependency>

2. via maven.pkg.github.com (requires authentication)

Add this to your <repositories> section:

<repository>
    <id>ScratchIt-repo</id>
    <url>https://maven.pkg.github.com/LoneDev6/API-ScratchIt</url>
</repository>

In your <dependencies> section (Replace VERSION with the latest release of this package):

<dependency>
    <groupId>dev.lone</groupId>
    <artifactId>api-ScratchIt</artifactId>
    <version>VERSION</version>
    <scope>provided</scope>
</dependency>

Note here that the GitHub package repository requires authentication! (Read more)
Alternatively, you can also include the dependency using jitpack.io.

Developer reference (Gradle)

1. via maven.pkg.github.com (requires authentication)

Repository:

repositories {
    maven {
        url 'https://maven.pkg.github.com/LoneDev6/API-ScratchIt'
    }
}

Artifact (Replace VERSION with the latest release of this package):

dependencies {
    implementation 'dev.lone:api-ScratchIt:VERSION'
}

Note here that the GitHub package repository requires authentication! (Read more)
Alternatively, you can also include the dependency using jitpack.io.

2. via jitpack.io

Repository:

repositories {
    maven {
        url 'https://jitpack.io'
    }
}

Artifact (Replace VERSION with the latest release of this package):

dependencies {
    implementation 'com.github.LoneDev6:API-ScratchIt:VERSION'
}