Skip to content

Commit 51a7a8c

Browse files
committed
Update README to fix formatting and remove travis badge
1 parent 351f17e commit 51a7a8c

File tree

1 file changed

+21
-12
lines changed

1 file changed

+21
-12
lines changed

README.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
# VaultAPI - Abstraction Library API for Bukkit Plugins - [![](https://travis-ci.org/MilkBowl/VaultAPI.svg?branch=master)](https://travis-ci.org/MilkBowl/VaultAPI)
1+
# VaultAPI - Abstraction Library API for Bukkit Plugins
2+
3+
How to include the API with Maven:
24

3-
How to include the API with Maven:
45
```xml
56
<repositories>
67
<repository>
@@ -19,6 +20,7 @@ How to include the API with Maven:
1920
```
2021

2122
How to include the API with Gradle:
23+
2224
```groovy
2325
repositories {
2426
maven { url 'https://repo.thenextlvl.net/releases' }
@@ -28,21 +30,25 @@ dependencies {
2830
}
2931
```
3032

31-
**Note**: The VaultAPI version has 2 numbers (major.minor), unlike Vault, which has 3. The 2 numbers in the VaultAPI will always correspond to the 2 beginning numbers in a Vault version to make it clear what versions your plugin will for sure work with.
33+
**Note**: The VaultAPI version has 2 numbers (major.minor), unlike Vault, which has 3. The 2 numbers in the VaultAPI
34+
will always correspond to the 2 beginning numbers in a Vault version to make it clear what versions your plugin will for
35+
sure work with.
3236

3337
## Why Vault?
38+
3439
I have no preference which library suits your plugin and development efforts
35-
best. Really, I thought a central suite (rather...Vault) of solutions was the
36-
the proper avenue than focusing on a single category of plugin. That's where
40+
best. Really, I thought a central suite (rather...Vault) of solutions was the
41+
the proper avenue than focusing on a single category of plugin. That's where
3742
the idea for Vault came into play.
3843

3944
So, what features do I _think_ you'll like the most?
4045

41-
* No need to include my source code in your plugin
42-
* Broad range of supported plugins
43-
* Choice!
46+
* No need to include my source code in your plugin
47+
* Broad range of supported plugins
48+
* Choice!
4449

4550
## License
51+
4652
Copyright (C) 2011-2018 Morgan Humes <[email protected]>
4753

4854
Vault is free software: you can redistribute it and/or modify
@@ -52,17 +58,20 @@ the Free Software Foundation, either version 3 of the License, or
5258

5359
Vault is distributed in the hope that it will be useful,
5460
but WITHOUT ANY WARRANTY; without even the implied warranty of
55-
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
61+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5662
GNU Lesser General Public License for more details.
5763

5864
You should have received a copy of the GNU Lesser General Public License
59-
along with Vault. If not, see <http://www.gnu.org/licenses/>.
65+
along with Vault. If not, see <http://www.gnu.org/licenses/>.
6066

6167
## Building
68+
6269
VaultAPI comes with all libraries needed to build from the current branch.
6370

6471
## Implementing Vault
65-
Implementing Vault is quite simple. It requires getting the Economy, Permission, or Chat service from the Bukkit ServiceManager. See the example below:
72+
73+
Implementing Vault is quite simple. It requires getting the Economy, Permission, or Chat service from the Bukkit
74+
ServiceManager. See the example below:
6675

6776
```java
6877
package com.example.plugin;
@@ -80,7 +89,7 @@ public class ExamplePlugin extends JavaPlugin {
8089
private static Economy economy = null;
8190
private static Permission permission = null;
8291
private static Chat chat = null;
83-
92+
8493
@Override
8594
public void onLoad() {
8695
if (getServer().getPluginManager().getPlugin("Vault") == null) {

0 commit comments

Comments
 (0)