diff options
| author | Tulir Asokan <tulir@maunium.net> | 2018-03-15 21:53:50 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-03-15 21:53:50 +0200 |
| commit | e69e494a52962c7dac0d6c2585b1cccadfc82e64 (patch) | |
| tree | ba53da076ea57aec8497b6a3fc85ed9a116c7b45 /README.md | |
| parent | f1b0526977de0c8f9953093d756e41dbc32617f5 (diff) | |
Update readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 13 insertions, 2 deletions
@@ -1,4 +1,15 @@ # gomuks -A terminal Matrix client written in Go. +A terminal Matrix client written in Go using [gomatrix](https://github.com/matrix-org/gomatrix) and [tview](https://github.com/rivo/tview). -Not yet actually usable, though receiving and sending messages works. +Very basic usage is possible, but many of the features you'd expect from a +Matrix client (like chat history) haven't been implemented. + +## Installation +Once the client becomes actually usable, I'll start making GitHub releases with +precompiled executables and maybe even some Linux packages. + +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` |