hiimgoodpack/brainlet-cli
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Wiki Activity

Better README

Browse source
This commit is contained in:
hiimgoodpack 2020-12-31 12:56:38 -05:00
parent 1e92cd541d
commit 2e3b40af2d
Signed by: hiimgoodpack
GPG key ID: 4E0E62733C14AE69
1 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -2,6 +2,12 @@
a better (unofficial) frontend for brainlet 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 # Installation
``` ```
git clone --depth=1 --recurse-submodules https://git.hippoz.xyz/hiimgoodpack/brainlet-cli.git git clone --depth=1 --recurse-submodules https://git.hippoz.xyz/hiimgoodpack/brainlet-cli.git
@ -16,3 +22,19 @@ npm install
``` ```
node index.js <server> node index.js <server>
``` ```
# 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 |