Update readme
This commit is contained in:
parent
f1b0526977
commit
e69e494a52
15
README.md
15
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`
|
||||
|
Loading…
Reference in New Issue
Block a user