From f5745c33ba70d9fd34d58dc322623c4bb36410ff Mon Sep 17 00:00:00 2001 From: Daylin Morgan Date: Tue, 14 Jun 2022 18:52:30 -0500 Subject: [PATCH] docs: update readme --- README.md | 41 ++++++++++++++++++++++++++++++++++++----- 1 file changed, 36 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 992f5c3..1d82a5e 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,25 @@ # YARTSU -yartsu, another rich terminal screenshot utility -![YARTSU LOGO](https://github.com/daylinmorgan/yartsu/blob/main/assets/logo.svg) -![YARTSU HELP](https://github.com/daylinmorgan/yartsu/blob/main/assets/yartsu.svg) +
+ + +
+ + Logo + +

+ yartsu, another rich terminal screenshot utility +

+
+
+ + +[![Stargazers][stars-shield]][stars-url] +[![Issues][issues-shield]][issues-url] +[![MIT License][license-shield]][license-url] + + **NOTE**: this is a currently in a beta release and the API is subject to change (feedback welcome) @@ -25,6 +41,8 @@ pip install yartsu ## Usage +
Logo
+ Getting a properly formatted output from a terminal screenshot is challenging. There are three options for generating a screenshot. @@ -39,7 +57,7 @@ you to force ANSI color codes to be included even when piping output. In these cases you can simply pipe the output directly into `yartsu` ```bash -ls --color=always / | yartsu -w 50 -o assets/ls_color.svg +ls --color=always | yartsu -w 50 -o assets/ls_color.svg ``` ### Option 2: Subprocess/Pty @@ -60,7 +78,7 @@ Finally, if you neither of the above options work and you can manage to preserve the codes in a plain text file you can pass this as input to `yartsu`. ```bash -ls --color / > ls.txt +ls --color > ls.txt yartsu -w 50 -i ls.txt -o assets/ls_color.svg ``` @@ -84,3 +102,16 @@ See [here](https://github.com/daylinmorgan/yartsu/blob/main/docs/themes.md) a pr - [ ] add support for nerd-fonts - [ ] add optional shadow - [ ] add more themes + + + +[contributors-shield]: https://img.shields.io/github/contributors/daylinmorgan/yartsu.svg?style=flat +[contributors-url]: https://github.com/daylinmorgan/yartsu/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/daylinmorgan/yartsu.svg?style=flat +[forks-url]: https://github.com/daylinmorgan/yartsu/network/members +[stars-shield]: https://img.shields.io/github/stars/daylinmorgan/yartsu.svg?style=flat +[stars-url]: https://github.com/daylinmorgan/yartsu/stargazers +[issues-shield]: https://img.shields.io/github/issues/daylinmorgan/yartsu.svg?style=flat +[issues-url]: https://github.com/daylinmorgan/yartsu/issues +[license-shield]: https://img.shields.io/github/license/daylinmorgan/yartsu.svg?style=flat +[license-url]: https://github.com/daylinmorgan/yartsu/blob/main/LICENSE.txt