add a basic README and a screenshot

Signed-off-by: Jakub Sokołowski <jakub@status.im>
This commit is contained in:
Jakub Sokołowski 2019-07-05 10:14:50 -04:00
parent 51c30bfa51
commit 5f425f9e30
No known key found for this signature in database
GPG Key ID: 4EF064D0E6D63020
3 changed files with 29 additions and 1 deletions

View File

@ -3,7 +3,7 @@ default: status-monitor
run: run:
go run ./*.go go run ./*.go
status-monitor: build:
go build -o bin/status-monitor go build -o bin/status-monitor
clean: clean:

28
README.md Normal file
View File

@ -0,0 +1,28 @@
# Description
This is a console client for manging peers connected to an instance of [status-go](https://github.com/status-im/status-go).
![](/img/status-go-monitor.png)
# Details
It is written in Go using [gocui](https://github.com/jroimartin/gocui) library.
# Building
The simplest way is to just run:
```
make build
```
And use it from the `bin` folder:
```
./bin/status-monitor
```
# TODO
* Command line options for connecting to `status-go`
* Confirmation dialogs for actions on peers
* Syncing of mailservers
* Info about current node
* Help screen / bindings list

BIN
img/status-go-monitor.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB