Skip to content
This repository has been archived by the owner on Nov 23, 2020. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jonahseguin authored Jan 16, 2020
1 parent 896c492 commit 9859a77
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,26 @@ It features *error handling*, *verbose debugging*, *an API with asynchronous eve
- Fast & easy to use across multiple services, plugins, and servers
- Seamless integration into networks or standalone servers
- Bungee/LilyPad/etc. (any network suite) support via use of a custom handshaking protocol & Redis pub/sub

# Install
Payload is designed to be run as a plugin, not to be shaded. The reasoning for this is that Payload provides commands for checking statuses and looking into details about databases, caches, profiles, and objects.

## Maven
To install with maven, clone the repository to your local machine first. And then install it into your local maven repository:
- `git clone git@github.com:jonahseguin/Payload.git`
- `cd Payload`
- `mvn clean package install`

Once that has finished, you can add Payload to the dependencies in your project:
```xml
<dependency>
<groupId>com.jonahseguin</groupId>
<artifactId>Payload</artifactId>
<version>3.1.0</version>
<scope>provided</scope>
</dependency>
```

## Usage
Guides for using Payload in Profile and Object cache modes can be found on the wiki for this repository.

0 comments on commit 9859a77

Please sign in to comment.