Add usage notes and screenshot

This commit is contained in:
Jakob Borg 2020-04-17 09:33:37 +02:00
parent aea66ff25a
commit 777a30e870
2 changed files with 18 additions and 0 deletions

View File

@ -1,5 +1,23 @@
# Syncthing Tech UI
## Usage
This is a very bare bones read-only GUI for viewing the status of large
setups. Download a [release
zip](https://github.com/kastelo/syncthing-tech-ui/releases) and unpack it
into the GUI override directory (assuming default Linux setup):
```
$ cd ~/.config/syncthing
$ mkdir -p gui/default
$ cd gui/default
$ unzip ~/tech-ui-v1.0.0.zip
```
Then load the GUI via http://localhost:8384/tech-ui/ or similar. You should see something like this:
![Screenshot](screenshot.png)
## Development server
Run `npm run serve` for a dev server. Navigate to `http://localhost:4200/`. The

BIN
screenshot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 734 KiB