Skip to content

Commit

Permalink
chore: update repo info in README
Browse files Browse the repository at this point in the history
  • Loading branch information
TheFruxz committed Dec 24, 2023
1 parent db81510 commit a531a22
Showing 1 changed file with 5 additions and 33 deletions.
38 changes: 5 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,48 +12,20 @@ It is designed, to perfectly fit into the Adventure API used at a Paper Environm

### Repository

How can I use Stacked in my own projects? For this you need to know what your project is based on, or should be based on.
How can I use Stacked in my own projects? For this, you need to know what your project is based on, or should be based on.
We ourselves recommend that you use `Gradle Kotlin` in all your projects, but you can also use other systems like `Gradle` and `Maven`!

#### Using JitPack
##### Repository
```kotlin
maven("https://jitpack.io")
```

##### Dependency
```kotlin
implementation("com.github.TheFruxz:Stacked:$stackedVersion")
```
### Use in your Gradle Project

#### Using GitHub Packages
##### Repository
#### Repository
```kotlin
maven("https://maven.pkg.github.com/TheFruxz/Stacked") {
credentials {
credentials {
username = project.findProperty("gpr.user") as String? ?: System.getenv("USERNAME")
password = project.findProperty("gpr.key") as String? ?: System.getenv("TOKEN")
}
}
}
maven("https://repo.fruxz.dev/releases/")
```

##### Dependency
```kotlin
implementation("de.fruxz:stacked:$stackedVersion")
implementation("dev.fruxz:stacked:$stackedVersion")
```

#### 🔐 Auth

You need to have set the system variables `USERNAME` and `TOKEN` to your GitHub-Username and GitHub-Personal-Access-Token,
to access the packages via the GitHub-Packages Feature. You can also use the project variables `gpr.user` and `gpr.key`, but
don't publish them to the web!

## 🗞 Version

Since we always try to use the latest versions as soon as possible, as already described in the point 'Version Policy', current versions quickly become obsolete, so we will soon release a list of versions, where it will be shown exactly how long a certain version is still being supported.

## 👥 Contribution

Of course, you can also participate in Stacked and contribute to the development. However, please follow all community and general guidelines of GitHub and the repositories. You also have to respect the licenses set in this repository as well as in other repositories.
Expand Down

0 comments on commit a531a22

Please sign in to comment.