diff --git a/README.md b/README.md index 7424a77..604ccde 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,10 @@ gim is a fast, high-performance, modular system metrics and diagnostics CLI tool ## Features -- **Modular Design**: Easy to extend with new metric collectors -- **Multiple Output Formats**: JSON, table, and raw output modes -- **Real-time Metrics**: CPU and memory usage statistics -- **Clean Architecture**: Well-structured codebase for easy maintenance +- *Modular Design*: Easy to extend with new metric collectors +- *Multiple Output Formats*: JSON, table, and raw output modes +- *Real-time Metrics*: CPU and memory usage statistics +- *Clean Architecture*: Well-structured codebase for easy maintenance ## Use Cases @@ -22,45 +22,20 @@ gim is a fast, high-performance, modular system metrics and diagnostics CLI tool ```bash # Clone the repository -git clone https://github.com/your-repo/gim.git +git clone [https://github.com/your-repo/gim.git](https://github.com/your-repo/gim.git) # Build the project cargo build --release -# Run with default settings +# Run with default settings (now includes CPU, Memory, and Disk) cargo run # Run a specific module cargo run -- --module cpu cargo run -- --module memory +cargo run -- --module disk # <--- Disk Module # Use different output formats cargo run -- --output json cargo run -- --output raw -cargo run -- --module cpu --output json -``` - -## Current Capabilities - -- **CPU Metrics**: Usage percentage, core count -- **Memory Metrics**: Total, used, free, available memory and swap -- **Output Options**: JSON, formatted table, or raw key-value pairs - -## Planned Features - -- Disk and network metric collectors -- TUI dashboard with ratatui -- Configuration file support -- Live monitoring capabilities - -## Documentation - -- [API Documentation](docs/api.md) -- [Architecture](docs/architecture.md) -- [Modules Guide](docs/modules.md) -- [Extending Guide](docs/extending.md) -- [Contributing](CONTRIBUTING.md) - -## License - -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. +cargo run -- --module cpu --output json \ No newline at end of file diff --git a/src/lib.rs b/src/lib.rs index ea751e4..12edf75 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -54,4 +54,4 @@ pub fn run() { Err(e) => eprintln!("Error collecting {} metrics: {}", collector.name(), e), } } -} +} \ No newline at end of file