From bf9354ceda71c285b652d1b6056875dd1e5d352f Mon Sep 17 00:00:00 2001 From: Tulir Asokan Date: Fri, 16 Mar 2018 16:35:52 +0200 Subject: [PATCH] Add usage instructions --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) 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 ` - Join the room with the given room ID or alias