Browse Source

Update README.md

master
Gregory Rudolph 2 years ago committed by GitHub
parent
commit
709ff33ae5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 41
      README.md

41
README.md

@ -1,39 +1,2 @@ @@ -1,39 +1,2 @@
# kbtui
Keybase TUI written in Go using [@dxb](https://keybase.io/dxb)'s
Keybase [bot framework](https://godoc.org/samhofi.us/x/keybase).
It started as a joke, then a bash script, and now here it is!
For support or suggestions check out the [kbtui team](https://keybase.io/team/kbtui)
## Features
* Dark Mode (or rather mode based on Terminal Theme)
* Read and reply to messages
* Feed view to see mentions
* Stream view to see all incoming messages
* List view to show activity
* Chat view to interact with the current channel
* Marks unread messages in the List view
* Reactions to messages
* Auto #general teams when not given a channel
* Pretty format headers in List view from window size
* Message editing
* Twitter-style feed reading public messages
* Message replies
## Todo
* Track multiple conversations at once
### Building and Running
Easiest Way:
```
go get -u github.com/rudi9719/kbtui
```
Or you can do the following:
```
go get github.com/magefile/mage/mage
go run build.go {build, buildBeta... etc}
./kbtui
```
Mage is a requirement for building `kbtui` as it will automatically handle/manage imports as well as mage is used to generate the
file for emoji completion.
# Announcement
Development on this branch of kbtui has been stopped and migrated to https://git.hugfreevikings.wtf/keybase/kbtui

Loading…
Cancel
Save