From 2e3b40af2d606a5be4231f494b0807397817758c Mon Sep 17 00:00:00 2001 From: hiimgoodpack Date: Thu, 31 Dec 2020 12:56:38 -0500 Subject: [PATCH] Better README --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 3f178bc..885f008 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,12 @@ a better (unofficial) frontend for brainlet +# Requirements +You should use a terminal supporting [VT100 escape codes](https://www.climagic.org/mirrors/VT100_Escape_Codes.html) and supporting [24-bit colors](https://en.wikipedia.org/wiki/ANSI_escape_code#24-bit). + +If you have a modern terminal, they probably have it. + +Any operating systems not using Linux are not supported. # Installation ``` git clone --depth=1 --recurse-submodules https://git.hippoz.xyz/hiimgoodpack/brainlet-cli.git @@ -16,3 +22,19 @@ npm install ``` node index.js ``` + +# Commands +## Normal commands +| Name | Description | +| :------: | :---------------------------------------------- | +| quit | Exits the client | +| signup | Creates an account | +| login | Logs into an account and connects to the server | +| ls | Lists categories | +| join | Joins a category | +| dump | (Debug) Prints user information | + +## Chat commands +| Name | Description | +| :------: | :---------------------------------------------- | +| /leave | Leaves the channel without telling the server | \ No newline at end of file