Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MohdMohsin97 authored Jul 26, 2024
1 parent 7cc6bdf commit 11cb002
Showing 1 changed file with 35 additions and 1 deletion.
36 changes: 35 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.


0 comments on commit 11cb002

Please sign in to comment.