Skip to content

Commit

Permalink
chore: icon & README
Browse files Browse the repository at this point in the history
  • Loading branch information
andantet committed Nov 15, 2024
1 parent e3a15f7 commit 8c4129a
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Slate *(for Kotlin)*

![Environment](https://img.shields.io/badge/Enviroment-Server-black)
[![Discord](https://img.shields.io/discord/1035236362263207936?color=blue&logo=discord&label=Discord)](https://discord.mcbrawls.net)

**Slate** is a library for server-side developers which makes creating clean server-side screens easy.

# Usage

Public builds of Slate can be found on the [Modrinth](https://modrinth.com/mod/slates) page.

To use Slate as a dependency you can find the artefact on our [public Maven repository](https://maven.andante.dev/#/releases/net/mcbrawls/slate).

`build.gradle`
```gradle
repositories {
maven {
name = "Andante's Maven"
url = "https://maven.andante.dev/releases/"
}
}
dependencies {
include modImplementation ("net.mcbrawls:slate:$slate_version")
}
```

`gradle.properties`
```properties
slate_version=1.0
```

# Getting Started

Slate is designed to be super simple.

```kt
val slate = slate()
slate.open(player)
```

This is all you need to create a slate! **To find out how to customise your slate, [see our wiki](https://github.com/mcbrawls/slate/wiki/Creating-Your-First-Slate).**
Binary file modified src/main/resources/assets/slate/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8c4129a

Please sign in to comment.