aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTulir Asokan <tulir@maunium.net>2018-03-16 16:35:52 +0200
committerGitHub <noreply@github.com>2018-03-16 16:35:52 +0200
commitbf9354ceda71c285b652d1b6056875dd1e5d352f (patch)
tree06c0749bece406b6e7594a14053306481bcae01f /README.md
parent586808df26eb91be65c4d715f959f63eb953d519 (diff)
Add usage instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index 378a95e..e4960da 100644
--- a/README.md
+++ b/README.md
@@ -15,3 +15,15 @@ For now, you'll have to compile from source:
0. Install [Go](https://golang.org/)
1. Run `go get -u maunium.net/go/gomuks`
2. gomuks should now be in `$GOPATH/bin/gomuks`
+
+## Usage
+
+Switch between rooms with ctrl + up/down arrow.
+
+Scroll chat with page up/down
+
+### Commands
+* `/quit` - Close gomuks
+* `/clearcache` - Clear room state cache and close gomuks
+* `/leave` - Leave the current room
+* `/join <room>` - Join the room with the given room ID or alias