From 16249ac842b137551421849fe273a3843117252f Mon Sep 17 00:00:00 2001 From: 2D <44017640+melike2d@users.noreply.github.com> Date: Mon, 26 Apr 2021 08:02:26 -0700 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20add=20guide=20for=20using=20obsi?= =?UTF-8?q?dian?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index b994cab..7e15387 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,21 @@ - Uses [**Lavaplayer**](https://github.com/sedmelluq/lavaplayer) - Performant, low memory and cpu footprint. +## Usage. + +For obsidian to work correctly you must use **Java 11** or above. + +- Goto the [releases page](/releases). +- Download the **Latest Jar File** +- Make an [`obsidian.yml`](/obsidian.yml) file in the same directory as the jar file +- Open a prompt in the same directory as the jar file. + +```sh +java -jar Obsidian.jar +``` + +Now go make a bot with the language and client of your choice! + ## Clients > Clients are used to interface with Magma, Obsidian's WebSocket and REST API.