From 9696726fb514a6853e60fa8c611bc8539170182c Mon Sep 17 00:00:00 2001
From: mohammed Alteniji <34905970+ham1255@users.noreply.github.com>
Date: Wed, 25 May 2022 09:11:19 +0400
Subject: [PATCH] Update README.md
---
README.md | 43 +++++++++++++++++++++++++------------------
1 file changed, 25 insertions(+), 18 deletions(-)
diff --git a/README.md b/README.md
index 1a37bfd..430c1c4 100644
--- a/README.md
+++ b/README.md
@@ -20,24 +20,31 @@ please create the issues on GitHub as its main project source.
## Compiling
RedisBungee is distributed as a [maven](https://maven.apache.org) project.
-To compile the plugin:
-
- git clone https://github.com/Limework/RedisBungee.git .
- mvn clean package
- mvn clean install # to install it in your maven local repo
-
-then you should find it in target folder.
-
-if you want to use it on your project considering you have installed it in your local repo
-
-
- com.imaginarycode.minecraft
- RedisBungee
- VERSION
- provided
-
-
-
+first, install it to your maven local repo as we don't have public maven repo.
+```
+git clone https://github.com/ProxioDev/RedisBungee.git
+cd RedisBungee
+mvn clean install
+```
+If you want to have `RedisBungeeAPI` class
+```
+
+ com.imaginarycode.minecraft
+ RedisBungee-API
+ 0.7.0-SNAPSHOT
+ provided
+
+```
+and if you want to use the events Import RedisBungee-BungeeEvents which for bungeecord
+`note: you need API imported too`
+```
+
+ com.imaginarycode.minecraft
+ RedisBungee-BungeeEvents
+ 0.7.0-SNAPSHOT
+ provided
+
+```
## Javadocs
Check out our Java docs on github pages
https://proxiodev.github.io/RedisBungee-JavaDocs/0.7.0-SNAPSHOT