Update README.md - add screenshot and brief usage/status descriptions

This commit is contained in:
Stephen Shelton 2019-10-06 09:58:10 -06:00 committed by GitHub
parent 21c065d347
commit 7b461239a7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions

View File

@ -1,5 +1,7 @@
# Lokinet Control Panel
![Screenshot](../media/images/lokinet_ui_screenshot.png?raw=true)
This repository contains a cross-platform GUI for controlling and observing stats from a locally-running `lokinet`. See also [loki-network](https://github.com/loki-project/loki-network).
### Building
@ -19,3 +21,11 @@ qmake ../lokicp.pro "CONFIG+=debug"
make
./lokicp
```
### Usage
The app starts running in the background with access available through the system tray. Click on the system tray icon to interact with the app.
### Status
This app is under heavy development. While the basic layout of the UI is established, the data is currently hard-coded.