๐ Update README
This commit is contained in:
parent
f669e93be5
commit
53f112795b
1 changed files with 14 additions and 16 deletions
30
README.md
30
README.md
|
|
@ -98,26 +98,15 @@ To clone the repository, use `git clone https://github.com/Sauilitired/cloud.git
|
|||
|
||||
To then build it, use `./gradlew clean build`. If you want to build the examples as well, use `./gradlew clean build
|
||||
-Pcompile-examples`.
|
||||
|
||||
There is a bash script (`build.sh`) that performs the submodule updating & builds the project.
|
||||
Feel free to use this if you want to.
|
||||
|
||||
## use
|
||||
|
||||
To use `cloud` you will first need to add it as a dependency to your project.
|
||||
|
||||
Snapshot builds of Cloud are available through the [Sonatype OSS Snapshot repository](https://oss.sonatype.org/content/repositories/snapshots).
|
||||
Release builds of Cloud are available through the Maven central repository.
|
||||
Snapshot builds of Cloud are available through the [Sonatype OSS Snapshot repository](https://oss.sonatype.org/content/repositories/snapshots).
|
||||
|
||||
**maven**:
|
||||
```xml
|
||||
<!-- For snapshot builds ->
|
||||
<repository>
|
||||
<id>sonatype-snapshots</id>
|
||||
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
|
||||
</repository>
|
||||
```
|
||||
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>cloud.commandframework</groupId>
|
||||
|
|
@ -135,6 +124,14 @@ Release builds of Cloud are available through the Maven central repository.
|
|||
</dependency>
|
||||
```
|
||||
|
||||
```xml
|
||||
<!-- For snapshot builds ->
|
||||
<repository>
|
||||
<id>sonatype-snapshots</id>
|
||||
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
|
||||
</repository>
|
||||
```
|
||||
|
||||
If you are shading in cloud, it is highly recommended that you relocate all of our classes to prevent issues
|
||||
with conflicting dependencies:
|
||||
|
||||
|
|
@ -161,11 +158,11 @@ with conflicting dependencies:
|
|||
<relocations>
|
||||
<relocation>
|
||||
<pattern>cloud.commandframework</pattern>
|
||||
<shadedPattern>YOUR.PACKAGE.HERE.cloud</shadedPattern> <!-- Replace this -->
|
||||
<shadedPattern>YOUR.PACKAGE.HERE.shaded.cloud</shadedPattern> <!-- Replace this -->
|
||||
</relocation>
|
||||
<relocation>
|
||||
<pattern>cloud.commandframework.services</pattern>
|
||||
<shadedPattern>YOUR.PACKAGE.HERE.cloud.pipeline</shadedPattern> <!-- Replace this -->
|
||||
<pattern>io.leangen.geantyref</pattern>
|
||||
<shadedPattern>YOUR.PACKAGE.HERE.shaded.typetoken</shadedPattern> <!-- Replace this -->
|
||||
</relocation>
|
||||
</relocations>
|
||||
</configuration>
|
||||
|
|
@ -177,7 +174,8 @@ with conflicting dependencies:
|
|||
**gradle**:
|
||||
```groovy
|
||||
repositories {
|
||||
maven { url = 'https://oss.sonatype.org/content/repositories/snapshots' }
|
||||
//maven { url = 'https://oss.sonatype.org/content/repositories/snapshots' } // For snapshots
|
||||
mavenCentral()
|
||||
}
|
||||
```
|
||||
|
||||
|
|
|
|||
Loadingโฆ
Add table
Add a link
Reference in a new issue