From e9afd0831aae40e25d51b20d8a68496ecc37f9d6 Mon Sep 17 00:00:00 2001
From: cloudwithax <heyimnick14@gmail.com>
Date: Wed, 15 Mar 2023 20:37:21 -0400
Subject: [PATCH] Update readme

---
 README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 63 insertions(+)

diff --git a/README.md b/README.md
index 24a6f3e..f370562 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,66 @@
 
 A fully-featured Lavalink client library for Lua that works seamlessly with Discordia.
 
+
+## NOTE
+
+This client library is in heavy development and **will** change drastically. Please do not use this production until all bugs have been worked out.
+
+
+# Installation
+
+To install this library, you must use the `lit` package manager as follows:
+
+```
+lit install cloudwithax/flare
+```
+
+
+# Example
+
+Heres a quick example:
+
+```lua
+local discordia = require('discordia')
+local flare      = require('flare')
+local Pool       = flare.Pool
+local Player     = flare.Player
+local Node       = flare.Node
+local client    = discordia.Client()
+
+
+
+local node = {
+    host = '127.0.0.1',
+    port = 2333,
+    password = 'youshallnotpass',
+    identifier = 'mynode'
+}
+
+client:on('ready', function()
+    Pool():create_node(client, node)
+    print('Logged in as ' .. client.user.username)
+end)
+
+client:on('messageCreate', function(message)
+
+    -- handle your commands here
+
+    if command == 'join' then
+        local player = Node:create_player(vc)
+
+    elseif command == 'play' then
+        local player = Node:get_player(guildid)
+        local tracks = player:get_tracks(query)
+        local track = tracks[1]
+        player:play(track)
+
+    elseif command == 'leave' then
+        local player = Node:get_player(guildid)
+        player:disconnect()
+    end
+end)
+
+client:run('Bot <your token here>')
+
+```