Skip to content

Commit a16d1cb

Browse files
committed
Add 'Repositories and Dependencies' section to README
1 parent 3ed5146 commit a16d1cb

File tree

1 file changed

+30
-3
lines changed

1 file changed

+30
-3
lines changed

README.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,15 @@ Gradle utilities for easier writing Bukkit plugins.
77
2. [Usage](#usage)
88
1. [First steps](#first-steps)
99
2. [Configuring plugin](#configuring-plugin)
10-
3. [Running Dev server](#running-dev-server)
10+
1. [Quotes around values](#quotes-around-values)
11+
3. [Repositories and Dependencies](#repositories-and-dependencies)
12+
4. [Running Dev server](#running-dev-server)
1113
1. [Server run configurations](#server-run-configurations)
1214

1315
#### Features:
1416
- Automatically applies plugins: java, idea, eclipse
1517
- Sets up compiler encoding to UTF-8
16-
- Adds repositories: mavenCentral, mavenLocal, spigot-repo, sk89q-repo
17-
- Provides short extension-functions to include bukkit/craftbukkit/spigot/spigot-api
18+
- Provides short extension-functions to add common repositories and dependencies
1819
- Generates plugin.yml from Gradle project information
1920
- Allows to run dev server from IDE
2021
- Automatically copies your plugin to plugins dir on server running
@@ -139,6 +140,32 @@ website: http://without.quot.es/
139140

140141
**Note:** In Groovy you can use functions in two ways: normal - `q("value")` and without braces - `q "value"`
141142

143+
### Repositories and Dependencies
144+
BukkitGradle provides short extension-functions to add common repositories and dependencies.
145+
There are list of its.
146+
147+
##### Repositories:
148+
Name | Url
149+
----------------|----------------------------------------------------------------
150+
spigot | https://hub.spigotmc.org/nexus/content/repositories/snapshots/
151+
sk98q | http://maven.sk89q.com/repo/
152+
destroystokyo | https://repo.destroystokyo.com/repository/maven-public/
153+
dmulloy2 | http://repo.dmulloy2.net/nexus/repository/public/
154+
md5 | http://repo.md-5.net/content/groups/public/
155+
vault | http://nexus.hc.to/content/repositories/pub_releases/
156+
placeholderapi | http://repo.extendedclip.com/content/repositories/placeholderapi/
157+
158+
##### Dependencies:
159+
Name | Signature
160+
-------------|-----------------------------------------------
161+
spigot | org.spigotmc:spigot:$apiVersion
162+
spigotApi | org.spigotmc:spigot-api:$apiVersion
163+
bukkit | org.bukkit:bukkit:$apiVersion
164+
craftbukkit | org.bukkit:craftbukkit:$apiVersion
165+
paperApi | com.destroystokyo.paper:paper-api:$apiVersion
166+
167+
**Note:** `$apiVersion` - is `${version}-R0.1-SNAPSHOT` (where `$version` is `bukkit.version`)
168+
142169
### Running Dev server
143170
Before running server you should configure dev server location.
144171

0 commit comments

Comments
 (0)