Updated the Read Me document.

This commit is contained in:
Hansly Saw 2022-04-29 15:55:35 +08:00 committed by GitHub
parent d71218b95b
commit fe1e79a6a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 35 additions and 2 deletions

View File

@ -1,2 +1,35 @@
# Kpopminal
Watch k-pop music videos in an ASCII format. Uses video-to-ascii by joelibaceta.
# Kpop'minal
Watch K-pop music videos in an ASCII format.
_Uses [`video-to-ascii` by joelibaceta](https://github.com/joelibaceta/video-to-ascii)_.
## How it came
One thing fascinating about command lines is that they can do many things that GUIs do, such as moving files, editing files, etc.
However, there are some things that CLIs can't do. You can't watch videos in there out of the box.
But there is _The Matrix_ that plays in ASCII. You can also watch a recreated _Star Wars_ just by using the `telnet` command.
**So what about watching k-pop videos in the terminal?**
With the help of [joelibaceta's `video-to-ascii`](https://github.com/joelibaceta/video-to-ascii), this is actually possible.
## What it does
Give the artist name, give the music video name, and run.
A script will be downloaded containing the ASCII version of the k-pop music video. This only works in POSIX and Linux OSes.
## Planned
[] Support input entries with all caps lock.
[] Localization
[] **more artists**
## About Copyright
The rights of these videos go to their artists and their entertainment agencies. In addition, this script is not affiliated with any of the artists.
## How to contribute
Yes, I'd love to receive feedback. Kindly let me know what you think!
When you would want to include a new music video, kindly make an issue mentioning the name and the _direct_ download URL of the video.