From d56fa7fc829d3a75ef2756e32feafa25b89e5ac9 Mon Sep 17 00:00:00 2001
From: Kiroo <33383685+zlfn@users.noreply.github.com>
Date: Thu, 17 Feb 2022 05:24:54 +0900
Subject: [PATCH] Update README.md

---
 README.md | 46 +++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 39 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index d4d41cd..aaec4ff 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,48 @@
 ![Logo](./image/tritonelogo.jpg)
 
-# TRITONE
-**Minecraft Client side in-game prioxity voice chatting via discord**
+# 🔉TRITONE
+**Minecraft in-game prioximity voice chatting mod via discord-game-sdk.**<br>
+This README.md was written by a non-English speaking person, so it might be awkward. Help us with PR!
 
-**This mod is currently under development and not yet available!!**
+**This mod is currently in beta! There may be bugs.**
 
-  ## Why not use this?
-   * There are many other Minecraft prioxity voice chat modes.
+  ## ✖ Why not use this?
+   * There are many other Minecraft prioximity voice chat modes.
    * Due to the limitations of Discord, 3D sound is not supported.
-  ## Why use this?
+  ## ✔ Why use this?
    * Tritone **does not** require any configuration on the server side. so, you can use Tritone on any public server in Minecraft.
-   * Discord's voice chat has better sound quality than other modes.
+   * Discord's voice chat has better sound quality than other mods.
+   * Setting up this mod is very, very easy.
+  ## ❓How to use?
+   ### 🚀installation
+   This mod currently supports windows forge 1.16.5 only. (Linux soon. MacOS somedays..)<br>
+   Just unzip the release zip file on your minecraft mods directory.<br>
+   **You must have a logged-in Discord installed on your computer.**
+   ### ✏Basic Use
+   After installing this mod and entering the multiplayer server, you will automatically be able to prioximity voice chat.<br>
+   * 'I' key makes you inaudible.
+   * 'M' key for mute yourself.
+   ### ✒Advanced Use
+   You can custom mod's discord applicationID and default lobby name via editing config.json <br>
+   This prevents voice chatting with unwanted people.
+   * clientID : Client ID issued by Discord developer site
+   * lobbyname : An alternative for those who are bothered by getting a clientID
+   
+   **It must have the same clientID and same lobbyname as the person you want to talk to.**
+  ## 🚩Roadmap
+   ### InProgress
+   * GUI
+   * Forge 1.12 support
+   * Linux support
+   ### Planned
+   * Forge 1.18 support
+   * Separation of lobbies by server
+   * MacOS support
+   * Multiple language support
+   ### Someday...
+   * Fabric support
+   * Forge 1.19+ support
+   
   ## For development...
    * We used Rust JNI for on-JVM use of discord-game-sdk.
    * Before building this project, you need some setup...