Skip to content

Commit

Permalink
Update README (#915)
Browse files Browse the repository at this point in the history
* remove experimental warning as discussed here:
  https://discord.com/channels/556525343595298817/587324906702766226/1192530833085575228

* put Gradle Kotlin DSL installation above Groovy DSL (for obvious
  reasons)

* replace example branch SNAPSHOT version with a fictional one, so it
  can't get outdated

[skip ci]
  • Loading branch information
lukellmann authored Mar 1, 2024
1 parent 69e838d commit 5b2d7f6
Showing 1 changed file with 13 additions and 24 deletions.
37 changes: 13 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,14 @@
# Kord

[![Discord](https://img.shields.io/discord/556525343595298817.svg?color=&label=Kord&logo=discord&style=for-the-badge)](https://discord.gg/6jcx5ev)
[![Download](https://img.shields.io/maven-central/v/dev.kord/kord-core.svg?label=Maven%20Central&style=for-the-badge)](https://search.maven.org/search?q=g:%22dev.kord%22%20AND%20a:%22kord-core%22)
[![Download](https://img.shields.io/maven-central/v/dev.kord/kord-core.svg?label=Maven%20Central&style=for-the-badge)](https://central.sonatype.com/artifact/dev.kord/kord-core)
[![Github CI status (branch)](https://img.shields.io/github/actions/workflow/status/kordlib/kord/deployment-ci.yml?branch=main&label=CI&style=for-the-badge)]()

__Kord is still in an experimental stage, as such we can't guarantee API stability between releases. While we'd love for
you to try out our library, we don't recommend you use this in production just yet.__

If you have any feedback, we'd love to hear it, hit us up on discord or write up an issue if you have any suggestions!

## What is Kord?

Kord is a [coroutine-based](https://kotlinlang.org/docs/reference/coroutines-overview.html), modularized implementation
of the Discord API, written 100% in [Kotlin](https://kotlinlang.org/).

If you have any feedback, we'd love to hear it, hit us up on discord or write up an issue if you have any suggestions!

## Why use Kord

Kord was created as an answer to the frustrations of writing Discord bots with other JVM libraries, which either use
Expand Down Expand Up @@ -61,44 +56,38 @@ Replace `{version}` with the latest version number on maven central.

For Snapshots replace `{version}` with `{branch}-SNAPSHOT`

e.g: `feature-mpp-SNAPSHOT` for the branch `feature/mpp`
e.g: `feature-amazing-thing-SNAPSHOT` for the branch `feature/amazing-thing`

For Snapshots for the branch `main` replace `{version}` with `{nextPlannedVersion}-SNAPSHOT` (see `nextPlannedVersion`
in [`gradle.properties`](gradle.properties))

[![Download](https://img.shields.io/maven-central/v/dev.kord/kord-core.svg?label=Maven%20Central&style=for-the-badge)](https://search.maven.org/search?q=g:%22dev.kord%22%20AND%20a:%22kord-core%22)
[![Download](https://img.shields.io/maven-central/v/dev.kord/kord-core.svg?label=Maven%20Central&style=for-the-badge)](https://central.sonatype.com/artifact/dev.kord/kord-core)

### Gradle (groovy)
### Gradle (Kotlin)

```groovy
```kotlin
repositories {
mavenCentral()
// Kord Snapshots Repository (Optional):
maven {
url "https://oss.sonatype.org/content/repositories/snapshots"
}
maven("https://oss.sonatype.org/content/repositories/snapshots")
}
```

```groovy
dependencies {
implementation("dev.kord:kord-core:{version}")
}
```

### Gradle (kotlin)
### Gradle (Groovy)

```kotlin
```groovy
repositories {
mavenCentral()
// Kord Snapshots Repository (Optional):
maven("https://oss.sonatype.org/content/repositories/snapshots")
maven {
url "https://oss.sonatype.org/content/repositories/snapshots"
}
}
```
---

```kotlin
dependencies {
implementation("dev.kord:kord-core:{version}")
}
Expand Down

0 comments on commit 5b2d7f6

Please sign in to comment.