diff --git a/README.md b/README.md index 39efb2f..75c17ef 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,8 @@ - [๐Ÿ“œ Table of contents](#-table-of-contents) - [โœจ Demo](#-demo) +- [๐Ÿ”ง Using](#-using) +- [๐Ÿงช Requirements for install](#-requirements-for-install) - [โšก Installing](#-installing) - [๐Ÿ”จ Compiling](#-compiling) - [๐Ÿ“š Contributing](#-contributing) @@ -31,6 +33,29 @@ demo +## ๐Ÿ”ง Using + +```bash +ponyfetch [OPTION] +``` + +| Option | Description | Type | Default | Required? | +|--------|----------------------------------------------------------|--------|---------|-----------| +| `-c` or `--color` | Defines what color to print pony and titles in | `String` | `blue` | No | +| `-p` or `--pony` | Pony to print | `String` | `rainbowdash` | No | +| `-h` or `--help` | Help menu in case you don't understand this one | | | No | + +## ๐Ÿงช Requirements for install + +On Linux (MAC not tested), install net-tools package using +```sh +sudo apt-get install net-tools +``` +or +```sh +sudo pacman -S net-tools +``` + ## โšก Installing @@ -52,8 +77,8 @@ chmod +x ./install.sh && sudo ./install.sh - ๐Ÿ–ฅ๏ธ On Windows -```txt -(WIP) Ponyfetch is still not available on Windows +```sh +./install.bat ``` - ๐ŸŽ On Mac