diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..b0b4f72 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,15 @@ +# EditorConfig file for fsmon + +root = true + +# Global settings +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true + +# Python-specific settings +[*.py] +indent_style = space +indent_size = 4 diff --git a/README.md b/README.md index 7f5ff34..8c8100d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,27 @@ -# fsmon +# fsmon: A Real-Time Btrfs I/O Monitor -fsmon: A Real-Time Btrfs I/O Monitor \ No newline at end of file +`fsmon` monitors the I/O activity of Btrfs filesystems in real time, displaying bandwidth and IOPS statistics for detected filesystems and their devices. + +It combines I/O statistics from all member devices of each Btrfs filesystem, providing a unified view of the filesystem's overall activity. + +## Features + +- Real-time monitoring of read/write bandwidth and IOPS. +- Visual charts for I/O statistics. +- Dynamic terminal size handling. +- Lightweight and efficient, leveraging sysfs for minimal overhead. + +## Requirements + +- Python 3.6 or higher. +- Btrfs filesystems mounted on the system. +- Sufficient permissions to access `/sys/fs/btrfs` and related devices in `/sys/block`. + +## Usage + +- `-h` or `--help`: Display usage information. +- `-v` or `--version`: Display version. + +## License + +This program is licensed under the [GNU General Public License v3.0 or later](https://www.gnu.org/licenses/gpl-3.0.html). \ No newline at end of file