From e69e494a52962c7dac0d6c2585b1cccadfc82e64 Mon Sep 17 00:00:00 2001 From: Tulir Asokan Date: Thu, 15 Mar 2018 21:53:50 +0200 Subject: Update readme --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index e5b24ac..26e187d 100644 --- a/README.md +++ b/README.md @@ -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` -- cgit v1.2.3