Reformat README.md

pull/1/head
sgoudham 3 years ago
parent d4878cba81
commit fba9d1639b

@ -17,6 +17,9 @@
* [About](#about) * [About](#about)
* [Features](#features) * [Features](#features)
* [Installation](#installation) * [Installation](#installation)
+ [Windows](#windows)
+ [Linux / macOS](#Linux-/-macOS)
+ [Rust/Cargo](#Rust/Cargo)
* [Usage](#usage) * [Usage](#usage)
+ [Text Input to Text Output](#text-input-to-text-output) + [Text Input to Text Output](#text-input-to-text-output)
+ [Text Input to File Output](#text-input-to-file-output) + [Text Input to File Output](#text-input-to-file-output)
@ -44,7 +47,8 @@ allows you to _uwu'ify_ text and files from within your own terminal in an _extr
## Installation ## Installation
Binaries for **Windows**, **macOS** & **Linux** are available with every single [release](https://github.com/sgoudham/uwuifyy/releases) Binaries for **Windows**, **macOS** & **Linux** are available with every
single [release](https://github.com/sgoudham/uwuifyy/releases)
### Windows ### Windows
@ -136,7 +140,7 @@ Rust [here](https://www.rust-lang.org/tools/install)
## Usage ## Usage
```shell ```commandline
USAGE: USAGE:
uwuifyy.exe [OPTIONS] <--text <TEXT>|--infile <FILE>> uwuifyy.exe [OPTIONS] <--text <TEXT>|--infile <FILE>>
@ -156,14 +160,14 @@ OPTIONS:
### Text Input to Text Output ### Text Input to Text Output
```shell ```shell
C:\Your\Path\Here> uwuifyy --text "According to all known laws of aviation, there is no way a bee should be able to fly." uwuifyy --text "According to all known laws of aviation, there is no way a bee should be able to fly."
> Accowding to aww knyown waws of aviation, thewe xDD is nyo way :3 a bee shouwd be abwe to *screams* fwy. Accowding to aww knyown waws of aviation, thewe xDD is nyo way :3 a bee shouwd be abwe to *screams* fwy.
``` ```
### Text Input to File Output ### Text Input to File Output
```shell ```shell
C:\Your\Path\Here> uwuifyy --text "According to all known laws of aviation, there is no way a bee should be able to fly." --outfile your/path/here/outfile.txt uwuifyy --text "According to all known laws of aviation, there is no way a bee should be able to fly." --outfile your/path/here/outfile.txt
[00:00:00] [############################################################] 104B/104B (0s) UwU'ifying Complete! [00:00:00] [############################################################] 104B/104B (0s) UwU'ifying Complete!
``` ```
@ -182,7 +186,7 @@ According to all known laws of aviation, there is no way a bee should be able to
``` ```
```shell ```shell
PS D:\Programming\Personal\uwuifyy> uwuifyy --infile your/path/here/infile.txt --outfile your/path/here/outfile.txt uwuifyy --infile your/path/here/infile.txt --outfile your/path/here/outfile.txt
[00:00:00] [############################################################] 85B/85B (0s) UwU'ifying Complete! [00:00:00] [############################################################] 85B/85B (0s) UwU'ifying Complete!
``` ```

Loading…
Cancel
Save