Alexander/gomuks
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add usage instructions

Browse Source
This commit is contained in:
Tulir Asokan 2018-03-16 16:35:52 +02:00 committed by GitHub
parent 586808df26
commit bf9354ceda
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -15,3 +15,15 @@ For now, you'll have to compile from source:
0. Install [Go](https://golang.org/) 0. Install [Go](https://golang.org/)
1. Run `go get -u maunium.net/go/gomuks` 1. Run `go get -u maunium.net/go/gomuks`
2. gomuks should now be in `$GOPATH/bin/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