From 10938c1d9855ab0432198d50bbc54834f5b71d85 Mon Sep 17 00:00:00 2001 From: Antonio De Lucreziis Date: Mon, 25 Dec 2023 01:06:37 +0100 Subject: [PATCH] chore: updated readme --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e0015ab..263ed41 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,15 @@ This Go project implements a simple TCP server that responds to custom commands ## Commands -The protocol supports the following commands: +The protocol supports the following commands: -- `cpu`: Returns the CPU usage as a percentage. -- `memory`: Returns the memory usage as a percentage. -- `network`: Returns the network statistics as a JSON object. -- `storage`: Returns the storage details as a JSON object. -- `uptime`: Returns the system uptime as a string. +- `cpu` — returns the CPU usage percentage +- `memory` — returns the memory usage in MB +- `network` — returns the network usage in bytes +- `storage` — returns the storage usage in GB +- `uptime` — returns the system uptime in seconds + +[TODO: check if the command docs are correct] ## Usage