From 11cb00200663134921bcbbdc92d83e115ebe75f1 Mon Sep 17 00:00:00 2001 From: Mohd Mohsin <136162998+MohdMohsin97@users.noreply.github.com> Date: Fri, 26 Jul 2024 16:29:39 +0530 Subject: [PATCH] Update README.md --- README.md | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1504bd7..947f9dc 100644 --- a/README.md +++ b/README.md @@ -1 +1,35 @@ -# system-monitoring +# System Monitoring + +This project is a terminal-based system monitoring tool built with Rust and the `ratatui` crate. It provides real-time visualization of CPU and memory usage. + +![system-monitoring](https://github.com/user-attachments/assets/50987a30-db6a-48e5-b43c-25631d0710e0) + +## Features + +- **CPU Usage Monitoring**: Displays real-time CPU usage as a line chart. +- **Memory Usage Monitoring**: Shows memory usage statistics with a detailed chart. + +## Installation + +1. Clone the repository: + ```bash + git clone https://github.com/MohdMohsin97/system-monitoring.git + cd system-monitoring + ``` + +2. Build run the project using Cargo: + ```bash + cargo run + ``` + + ## Key Bindings +- 'q' or 'Esc': Exit the application. + +## Contributing +1. Fork the repository. +2. Create a new branch (git checkout -b feature-branch). +3. Commit your changes (git commit -am 'Add new feature'). +4. Push to the branch (git push origin feature-branch). +5. Create a new Pull Request. + +