Update module READMEs

This reduces duplication in the README files of the individual modules and fixes some outdated links and code. [skip ci]
kordlib · Jul 29, 2024 · 05908bc · 05908bc
1 parent 99c67d7
commit 05908bc
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 160 deletions.
diff --git a/core/README.md b/core/README.md
@@ -1,8 +1,8 @@
 # Kord Core
 
-Kord `core` is an implementation of the discord api build on top of the [gateway](https://gitlab.com/kordlib/kord/tree/master/gateway), 
-[rest](https://gitlab.com/kordlib/kord/tree/master/rest) and [cache](https://gitlab.com/kordlib/cache) modules. It features a high level representation of Discord's entities and their behaviour
-in a non-blocking, coroutine focused, event-driven design.
+Kord `core` is an implementation of the discord api build on top of the [gateway](../gateway), [rest](../rest) and
+[cache](https://github.com/kordlib/cache) modules. It features a high level representation of Discord's entities and
+their behavior in a non-blocking, coroutine focused, event-driven design.
 
 ## Example usage
 
@@ -31,72 +31,30 @@ suspend fun main() {
     }
 }
 ```
-## Installation
-
-Replace `{version}` with the latest version number on maven central.
-
-For Snapshots replace `{version}` with `{branch}-SNAPSHOT`
 
-e.g: `0.7.x-SNAPSHOT`
+## Installation
 
-[![Download](https://img.shields.io/nexus/r/dev.kord/kord-core?color=fb5502&label=Kord&logoColor=05c1fd&server=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2F&style=for-the-badge) ](https://search.maven.org/search?q=g:dev.kord)
-[![Snapshot](https://img.shields.io/nexus/s/dev.kord/kord-core?label=SNAPSHOT&server=https%3A%2F%2Foss.sonatype.org%2F&style=for-the-badge)](https://oss.sonatype.org/#nexus-search;quick~dev.kord)
-### Gradle (groovy)
+See the root [README](../README.md#installation) for more information.
 
-```groovy
-repositories {
-    mavenCentral()
-    // Kord Snapshots Repository (Optional):
-    maven("https://oss.sonatype.org/content/repositories/snapshots")
-}
-```
+### Gradle (Kotlin)
 
-```groovy
+```kotlin
 dependencies {
     implementation("dev.kord:kord-core:{version}")
 }
 ```
 
-### Gradle (kotlin)
+### Gradle (Groovy)
 
-```kotlin
-repositories {
-    mavenCentral()
-    // Kord Snapshots Repository (Optional):
-    maven("https://oss.sonatype.org/content/repositories/snapshots")
-}
-```
-
----
-
-```kotlin
+```groovy
 dependencies {
     implementation("dev.kord:kord-core:{version}")
 }
 ```
 
 ### Maven
 
-##### Kord Snapshots Repository (Optional):
-
 ```xml
-
-<repository>
-    <id>snapshots-repo</id>
-    <url>https://oss.sonatype.org/content/repositories/snapshots</url>
-    <releases>
-        <enabled>false</enabled>
-    </releases>
-    <snapshots>
-        <enabled>true</enabled>
-    </snapshots>
-</repository>
-```
-
----
-
-```xml
-
 <dependency>
     <groupId>dev.kord</groupId>
     <artifactId>kord-core-jvm</artifactId>

diff --git a/gateway/README.md b/gateway/README.md
@@ -1,6 +1,6 @@
 # Kord gateway
 
-A low-level implementation of discord's [gateway](https://discordapp.com/developers/docs/topics/gateway).
+A low-level implementation of discord's [gateway](https://discord.com/developers/docs/topics/gateway).
 
 ## Example usage
 
@@ -11,7 +11,9 @@ suspend fun main(args: Array<String>) {
     val gateway = DefaultGateway { // optional builder for custom configuration
         client = HttpClient {
             install(WebSockets)
-            install(JsonFeature)
+            install(ContentNegotiation) {
+                json()
+            }
         }
         reconnectRetry = LinearRetry(2.seconds, 20.seconds, 10)
         sendRateLimiter = IntervalRateLimiter(120, 60.seconds)
@@ -39,73 +41,30 @@ suspend fun main(args: Array<String>) {
     }
 }
 ```
-## Installation
-
-Replace `{version}` with the latest version number on maven central.
-
-For Snapshots replace `{version}` with `{branch}-SNAPSHOT`
 
-e.g: `0.7.x-SNAPSHOT`
+## Installation
 
-[![Download](https://img.shields.io/nexus/r/dev.kord/kord-gateway?color=fb5502&label=Kord&logoColor=05c1fd&server=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2F&style=for-the-badge) ](https://search.maven.org/search?q=g:dev.kord)
-[![Snapshot](https://img.shields.io/nexus/s/dev.kord/kord-gateway?label=SNAPSHOT&server=https%3A%2F%2Foss.sonatype.org%2F&style=for-the-badge)](https://oss.sonatype.org/#nexus-search;quick~dev.kord)
+See the root [README](../README.md#installation) for more information.
 
-### Gradle (groovy)
+### Gradle (Kotlin)
 
-```groovy
-repositories {
-    mavenCentral()
-    // Kord Snapshots Repository (Optional):
-    maven("https://oss.sonatype.org/content/repositories/snapshots")
-}
-```
-
-```groovy
+```kotlin
 dependencies {
     implementation("dev.kord:kord-gateway:{version}")
 }
 ```
 
-### Gradle (kotlin)
+### Gradle (Groovy)
 
-```kotlin
-repositories {
-    mavenCentral()
-    // Kord Snapshots Repository (Optional):
-    maven("https://oss.sonatype.org/content/repositories/snapshots")
-}
-```
-
----
-
-```kotlin
+```groovy
 dependencies {
     implementation("dev.kord:kord-gateway:{version}")
 }
 ```
 
 ### Maven
 
-##### Kord Snapshots Repository (Optional):
-
 ```xml
-
-<repository>
-    <id>snapshots-repo</id>
-    <url>https://oss.sonatype.org/content/repositories/snapshots</url>
-    <releases>
-        <enabled>false</enabled>
-    </releases>
-    <snapshots>
-        <enabled>true</enabled>
-    </snapshots>
-</repository>
-```
-
----
-
-```xml
-
 <dependency>
     <groupId>dev.kord</groupId>
     <artifactId>kord-gateway-jvm</artifactId>

diff --git a/rest/README.md b/rest/README.md
@@ -13,75 +13,31 @@ suspend fun main(args: Array<String>) {
     val username = rest.user.getCurrentUser().username
     println("using $username's token")
 }
-``` 
-## Installation
-
-Replace `{version}` with the latest version number on maven central.
-
-For Snapshots replace `{version}` with `{branch}-SNAPSHOT`
-
-e.g: `0.7.x-SNAPSHOT`
+```
 
-[![Download](https://img.shields.io/nexus/r/dev.kord/kord-rest?color=fb5502&label=Kord&logoColor=05c1fd&server=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2F&style=for-the-badge) ](https://search.maven.org/search?q=g:dev.kord)
-[![Snapshot](https://img.shields.io/nexus/s/dev.kord/kord-rest?label=SNAPSHOT&server=https%3A%2F%2Foss.sonatype.org%2F&style=for-the-badge)](https://oss.sonatype.org/#nexus-search;quick~dev.kord)
+## Installation
 
+See the root [README](../README.md#installation) for more information.
 
-### Gradle (groovy)
+### Gradle (Kotlin)
 
-```groovy
-repositories {
-    mavenCentral()
-    // Kord Snapshots Repository (Optional):
-    maven("https://oss.sonatype.org/content/repositories/snapshots")
-}
-```
-
-```groovy
+```kotlin
 dependencies {
     implementation("dev.kord:kord-rest:{version}")
 }
 ```
 
-### Gradle (kotlin)
-
-```kotlin
-repositories {
-    mavenCentral()
-    // Kord Snapshots Repository (Optional):
-    maven("https://oss.sonatype.org/content/repositories/snapshots")
-}
-```
-
----
+### Gradle (Groovy)
 
-```kotlin
+```groovy
 dependencies {
     implementation("dev.kord:kord-rest:{version}")
 }
 ```
 
 ### Maven
 
-##### Kord Snapshots Repository (Optional):
-
 ```xml
-
-<repository>
-    <id>snapshots-repo</id>
-    <url>https://oss.sonatype.org/content/repositories/snapshots</url>
-    <releases>
-        <enabled>false</enabled>
-    </releases>
-    <snapshots>
-        <enabled>true</enabled>
-    </snapshots>
-</repository>
-```
-
----
-
-```xml
-
 <dependency>
     <groupId>dev.kord</groupId>
     <artifactId>kord-rest-jvm</artifactId>

diff --git a/voice/README.md b/voice/README.md
@@ -124,27 +124,26 @@ processIncomingAudio(connection.streams.incomingAudioFrames)
 
 ## Installation
 
-Replace `{version}` with the latest version number on maven central.
+See the root [README](../README.md#installation) for more information.
 
-[![Download](https://img.shields.io/maven-central/v/dev.kord/kord-voice.svg?color=fb5502&label=Kord&logoColor=05c1fd&style=for-the-badge)](https://search.maven.org/search?q=g:%22dev.kord%22%20AND%20a:%22kord-voice%22)
+### Gradle (Kotlin)
 
-### Gradle (groovy)
-```groovy
+```kotlin
 dependencies {
     implementation("dev.kord:kord-voice:{version}")
 }
 ```
 
-### Gradle (kotlin)
-```kotlin
+### Gradle (Groovy)
+
+```groovy
 dependencies {
     implementation("dev.kord:kord-voice:{version}")
 }
 ```
 
 ### Maven
 
-##### Kord Snapshots Repository (Optional):
 ```xml
 <dependency>
     <groupId>dev.kord</groupId>