Skip to content

Commit 534dc4c

Browse files
committed
added badge and screenshot
1 parent f52d774 commit 534dc4c

File tree

3 files changed

+5
-4
lines changed

3 files changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
# Device Chronicle [![Go Server](https://github.com/pyprism/Device-Chronicle/actions/workflows/go.yaml/badge.svg)](https://github.com/pyprism/Device-Chronicle/actions/workflows/go.yaml)
2-
1+
# Device Chronicle [![Client](https://github.com/pyprism/Device-Chronicle/actions/workflows/client.yaml/badge.svg)](https://github.com/pyprism/Device-Chronicle/actions/workflows/client.yaml) [![Server](https://github.com/pyprism/Device-Chronicle/actions/workflows/server.yaml/badge.svg)](https://github.com/pyprism/Device-Chronicle/actions/workflows/server.yaml)
32
Device Chronicle is a lightweight system monitoring tool that collects and visualizes realtime performance metrics from your devices. It consists of a server component (web dashboard) and client agents that run on monitored systems.
43

54
## Features
@@ -35,11 +34,13 @@ Device Chronicle is a lightweight system monitoring tool that collects and visua
3534

3635
1. Install the client on each system you want to monitor:
3736
```bash
37+
chmod +x ./chronicle-client
3838
./chronicle-client --install --server http://SERVER_IP:8000 --client DEVICE_NAME
3939
```
4040
###### Note:
4141
- Download the client binary from the [releases page](https://github.com/pyprism/Device-Chronicle/releases)
42-
- Replace `SERVER_IP` with the IP address of the server and `DEVICE_NAME` with a unique name for the device
42+
- Replace `SERVER_IP` with the IP address of the server or domain name and `DEVICE_NAME` with a unique name for the device
43+
- In case for updating the client, stop the service first `systemctl --user stop chronicle-client`
4344

4445

4546
2. The client will automatically start and connect to the server
@@ -111,7 +112,7 @@ By creating a lightweight monitoring tool with a web interface accessible from a
111112
## Status
112113
Beta
113114
## Screenshot
114-
<img src="/image.png" width="80%" alt="ugly screenshot">
115+
<img src="/screenshot.png" width="80%" alt="ugly screenshot">
115116

116117
## Development
117118

image.png

-166 KB
Binary file not shown.

screenshot.png

350 KB
Loading

0 commit comments

Comments
 (0)