Limework
/
RedisBungee
mirror of https://github.com/proxiodev/RedisBungee.git
2
0
Fork 0
Code Releases Activity

Update README.md

This commit is contained in:
mohammed Alteniji 2022-05-25 09:11:19 +04:00 committed by GitHub
parent 86eeacbb1c
commit 9696726fb5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -20,24 +20,31 @@ please create the issues on GitHub as its main project source.
## Compiling ## Compiling
RedisBungee is distributed as a [maven](https://maven.apache.org) project. RedisBungee is distributed as a [maven](https://maven.apache.org) project.
To compile the plugin: first, install it to your maven local repo as we don't have public maven repo.
```
git clone https://github.com/Limework/RedisBungee.git . git clone https://github.com/ProxioDev/RedisBungee.git
mvn clean package cd RedisBungee
mvn clean install # to install it in your maven local repo mvn clean install
```
then you should find it in target folder. If you want to have `RedisBungeeAPI` class
```
if you want to use it on your project considering you have installed it in your local repo <dependency>
<groupId>com.imaginarycode.minecraft</groupId>
<dependency> <artifactId>RedisBungee-API</artifactId>
<groupId>com.imaginarycode.minecraft</groupId> <version>0.7.0-SNAPSHOT</version>
<artifactId>RedisBungee</artifactId> <scope>provided</scope>
<version>VERSION</version> </dependency>
<scope>provided</scope> ```
</dependency> and if you want to use the events Import RedisBungee-BungeeEvents which for bungeecord
`note: you need API imported too`
```
<dependency>
<groupId>com.imaginarycode.minecraft</groupId>
<artifactId>RedisBungee-BungeeEvents</artifactId>
<version>0.7.0-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
```
## Javadocs ## Javadocs
Check out our Java docs on github pages Check out our Java docs on github pages
https://proxiodev.github.io/RedisBungee-JavaDocs/0.7.0-SNAPSHOT https://proxiodev.github.io/RedisBungee-JavaDocs/0.7.0-SNAPSHOT