From c4538200b6ae453847430fa8f011aca073caca77 Mon Sep 17 00:00:00 2001 From: Bexx Modebadze Date: Sun, 13 Sep 2020 18:53:04 -0400 Subject: [PATCH] Updated README --- README.md | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 71 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d796db6..05f10ed 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,78 @@

+[![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/) +[![GitHub release](https://img.shields.io/github/release/Naereen/StrapDown.js.svg)](https://GitHub.com/Naereen/StrapDown.js/releases/) - -**vizex** is the terminal program for the UNIX/Linux systems which helps user to visualize the disk space usage for every partition and media on the user's machine. **vizex** is highly customizable and can fit any user's taste and preferences. +**vizex** is the terminal program for the UNIX/Linux systems which helps the user to visualize the disk space usage for every partition and media on the user's machine. **vizex** is highly customizable and can fit any user's taste and preferences. ---- + +## Installation +**vizex** is packaged through the `pypi` which makes it easy to install: +``` +pip install vizex +``` + + ## How it Works -After installetion run the command `vizex` in your terminal and it will displaye graphically disk space and disk space usage. +[------video goes here-------] + +After installing run the program with a single command `vizex` in your terminal. This will graphically display disk space and usage: + +Change the graph type from horizontal bars or to the vertical bars or to the *pie charts (in works). +``` +vizex barv +``` + +But the best part is that you can modify the colors and style of the display to your preferences with following commands: + +``` +-d --header +-s --style +-t --text +-g --graph +``` + +Or exclude any combination of partitions/disks with: +``` +-I -I ... +``` + +For the full list of the available options please check: +``` +vizex --help +``` + +## File Structure +```bash +├── cli.py +├── disk.py +├── LICENSE +├── pkg +│ └── __init__.py +├── README.md +├── requirements.txt +├── setup.py +└── tests + ├── access.py + ├── test_cli.py + └── test_disk.py +``` + +------ +## Follow me on Social Media +

+ + twitter + + + linkedin + + + github + +

+ +-------- +Repo is distributed under the MIT license. Please see the `LICENSE` for more information. \ No newline at end of file