Skip to content

Commit e930b7f

Browse files
authored
Update index.md (PurpurMC#68)
1 parent dfdedfd commit e930b7f

1 file changed

Lines changed: 56 additions & 15 deletions

File tree

mkdocs/index.md

Lines changed: 56 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -52,46 +52,87 @@ See [PaperMC/Paper](https://github.com/PaperMC/Paper) for the license of materia
5252
## API
5353

5454
### Javadoc
55-
56-
{{ project.javadoc }}
55+
You can find the Javadocs for Purpur at: {{ project.javadoc }}
5756

5857
### Dependency Information
5958
=== "Maven"
6059

6160
``` xml linenums="1"
62-
<repository>
63-
<id>purpur</id>
64-
<url>https://repo.purpurmc.org/snapshots</url>
65-
</repository>
61+
<repositories>
62+
<!-- other repos... -->
63+
<repository>
64+
<id>purpur</id>
65+
<name>Purpur Maven Repo</name>
66+
<url>https://repo.purpurmc.org/snapshots</url>
67+
</repository>
68+
<!-- other repos... -->
69+
</repositories>
6670
```
6771
``` xml linenums="1"
68-
<dependency>
69-
<groupId>org.purpurmc.purpur</groupId>
70-
<artifactId>purpur-api</artifactId>
71-
<version>{{ project.version }}-R0.1-SNAPSHOT</version>
72-
<scope>provided</scope>
73-
</dependency>
72+
<dependencies>
73+
<!-- other dependencies -->
74+
<dependency>
75+
<groupId>org.purpurmc.purpur</groupId>
76+
<artifactId>purpur-api</artifactId>
77+
<version>{{ project.version }}-R0.1-SNAPSHOT</version>
78+
<scope>provided</scope>
79+
</dependency>
80+
<!-- other dependencies -->
81+
</dependencies>
7482
```
7583

76-
=== "Gradle"
84+
=== "Gradle (Kotlin)"
7785

7886
``` kotlin linenums="1"
7987
repositories {
88+
//... other repos ...//
89+
90+
//Add this somewhere after mavenCentral()
8091
maven("https://repo.purpurmc.org/snapshots")
92+
93+
//... other repos ...//
8194
}
8295
```
8396
``` kotlin linenums="1"
8497
dependencies {
98+
//... other dependencies ...//
99+
85100
compileOnly("org.purpurmc.purpur", "purpur-api", "{{ project.version }}-R0.1-SNAPSHOT")
101+
102+
//... other dependencies ...//
103+
}
104+
```
105+
106+
=== "Gradle (Groovy)"
107+
108+
``` groovy linenums="1"
109+
repositories {
110+
//... other repos ...//
111+
112+
//Add this somewhere after mavenCentral()
113+
maven {
114+
url "https://repo.purpurmc.org/snapshots"
115+
}
116+
117+
//... other repos ...//
86118
}
87119
```
120+
``` groovy linenums="1"
121+
dependencies {
122+
//... other dependencies ...//
123+
124+
compileOnly "org.purpurmc.purpur:purpur-api:{{ project.version }}-R0.1-SNAPSHOT"
125+
126+
//... other dependencies ...///
127+
}
128+
````
88129

89-
Yes, this also includes all APIs provided by Pufferfish, Paper, Spigot, and Bukkit.
130+
Importing Purpur into your project also includes all APIs provided by Pufferfish, Paper, Spigot, and Bukkit.
90131

91132
## Building and setting up
92133

93134
#### Initial setup
94-
Run the following commands in the root directory:
135+
Run the following command in the root of the project directory:
95136

96137
``` bash linenums="1"
97138
./gradlew applyPatches

0 commit comments

Comments
 (0)